EnformionGO API

https://enformiongo.readme.io/reference/
Admin
EnformionGO API is a comprehensive data enrichment and search platform providing access to contact,...
Tokens:159,103
Snippets:640
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Cities Example

Source: https://enformiongo.readme.io/reference/get-cities

This snippet demonstrates how to retrieve a list of cities. Ensure you have the necessary authentication and endpoint configured.

```json
{
  "data": [
    {
      "id": "1",
      "name": "New York",
      "state": "NY",
      "country": "USA"
    },
    {
      "id": "2",
      "name": "Los Angeles",
      "state": "CA",
      "country": "USA"
    }
  ],
  "message": "Cities retrieved successfully.",
  "timestamp": "2023-10-27T10:00:00Z"
}
```

--------------------------------

### Sample Response for Get Departments (Regional)

Source: https://enformiongo.readme.io/reference/get-departments-regional

This is an example of a successful response, showing the found department(s) and search details.

```json
{
    "searchRecords": [
        "FINANCE AND ADMINISTRATION"
    ],
    "responseRecordCount": 1,
    "pagination": {
        "currentPageNumber": 0,
        "resultsPerPage": 0,
        "totalPages": 0
    },
    "searchCriteria": [],
    "totalRequestExecutionTimeMs": 471,
    "requestId": "3d861a1f-315a-45c3-9347-1ee8bec7d16f",
    "requestType": "Search",
    "requestTime": "2022-01-24T14:18:18.9109549-06:00",
    "isError": false
}
```

--------------------------------

### OpenAPI Definition Example

Source: https://enformiongo.readme.io/reference/contact-enrichment-search

An example snippet from an OpenAPI definition, showing proxy configuration and an internal ID.

```json
{
  "proxy-enabled": true
},
"x-readme-fauxas": true,
"_id": "6824a5c83169e10059adfb95:6824a5c83169e10059adfdd2"
}
```

--------------------------------

### Property V2 Search Response Example

Source: https://enformiongo.readme.io/reference/property-v2-search

This example demonstrates a successful response from the Property V2 Search API, including mortgage details and lender information.

```json
{
  "Results": [
    {
      "Property": {
        "MortgageSequenceNumber": "1",
        "MortgageAmount": "20000.00",
        "MortgageDate": "04/20/2000",
        "MortgageRecordingDate": "04/20/2000",
        "MortgageInterestRateType": "FIX",
        "MortgageInterestRateTypeDescription": "",
        "MortgageLoanTypeCode": "CNV",
        "MortgageLoanTypeCodeDescription": "",
        "MortgageDocumentType": "TR",
        "MortgageRecordedDocumentNumber": "26144",
        "MortgageRecordedDocumentBookAndPage": "",
        "MortgageTermCode": "",
        "MortgageTermCodeDescription": "",
        "MortgageTerm": "",
        "MortgageDueDate": "",
        "MortgageAssumptionAmount": "",
        "ConformingLoanIndicator": "1",
        "ConventionalLoanIndicator": "1",
        "EquityLoanIndicator": "0",
        "FhaLoanIndicator": "0",
        "FixedRateIndicator": "1",
        "NonConformingLoanIndicator": "0",
        "OtherSubordinateLoanIndicator": "0",
        "VeteransAdministrationLoanIndicator": "0",
        "VariableRateLoanIndicator": "0",
        "MortgageInterestRate": "",
        "ConstructionLoanIndicator": "0",
        "PrivatePartyLenderIndicator": "0",
        "RefinanceLoanIndicator": "0",
        "SellerCarryBackIndicator": "0",
        "SmallBusinessAdministrationLoanIndicator": "0",
        "Lenders": [
          {
            "CompanyName": null,
            "CompanyCode": "009810",
            "Name": {
              "CompanyCode": null,
              "CompanyName": null,
              "Md5Hash": "5517212049190176275",
              "FullName": "Seller Lender",
              "FirstName": "Seller",
              "MiddleName": "",
              "LastName": "Lender",
              "Suffix": "",
              "TahoeId": null
            },
            "Address": {
              "Md5Hash": "1072797854664122868",
              "HouseNumber": "",
              "StreetDirection": "",
              "StreetName": "",
              "StreetType": "",
              "UnitType": "",
              "Unit": "",
              "StreetPostDirection": "",
              "City": "Fresno",
              "State": "CA",
              "County": "Fresno",
              "ZipCode": "93720",
              "Zip4": "0153",
              "Latitude": "",
              "Longitude": "",
              "CareOfName": "",
              "CityStateZipSource": "",
              "OptOutIndicator": "",
              "DeliveryPointValidationCode": "",
              "DeliveryPointValidationVacantIndicator": "",
              "AddressLine1": "",
              "AddressLine2": "Fresno, CA 93720-0153",
              "FullAddress": "Fresno, CA 93720-0153"
            }
          }
        ],
        "MortgageArmRider": null
      }
    }
  ],
  "Counts": {
    "SearchResults": 1
  },
  "Pagination": {
    "CurrentPageNumber": 1,
    "ResultsPerPage": 10,
    "TotalPages": 1
  }
}
```

--------------------------------

### Search API Request Example

Source: https://enformiongo.readme.io/reference/search-3

An example of a request body for the Search API. Populate the fields with the relevant search criteria.

```json
{
  "FirstName": "",
  "LastName": "",
  "Dob": "",
  "AddressLine1": "",
  "AddressLine2": "",
  "Email": "",
  "Phone": ""
}
```

--------------------------------

### Vehicle Ownership Search Example

Source: https://enformiongo.readme.io/reference/vehicle-ownership-search

This example demonstrates a successful response for a vehicle ownership search, returning detailed registration information.

```json
{
  "VehicleId": "1001CN7662A",
  "LicensePlateNumber": "081TLL",
  "LicensePlateState": "TN",
  "Make": "Gmc",
  "Model": "",
  "Year": "1960",
  "Color": "",
  "Series": "100",
  "Style": "Pickup",
  "Type": "",
  "Weight": "2560",
  "Length": "",
  "NameCode": "Registrant",
  "RegistrationDate": 20080612,
  "ExpirationDate": 20100630,
  "TitleDate": 20080612,
  "TransactionDate": 20080612,
  "RegistrationDateFormatted": "6/12/2008",
  "ExpirationDateFormatted": "6/30/2010",
  "TitleDateFormatted": "6/12/2008",
  "TransactionDateFormatted": "6/12/2008"
}
```

--------------------------------

### Add Subscription Search Response Example

Source: https://enformiongo.readme.io/reference/add-subscription-search

This example shows a successful response from the Add Subscription Search endpoint. It confirms the subscription addition status, record count, and request details.

```json
{
    "isAddSubscriptionSuccessful": true,
    "responseRecordCount": 0,
    "pagination": {
        "currentPageNumber": 0,
        "resultsPerPage": 0,
        "totalPages": 0
    },
    "searchCriteria": [],
    "totalRequestExecutionTimeMs": 7,
    "requestId": "faaf13fe-71ec-4cb9-84f7-9b5b69834085",
    "requestType": "Search",
    "requestTime": "2021-10-20T09:04:47.7398532-07:00",
    "isError": false
}
```

--------------------------------

### Workplace Search POST Request Example

Source: https://enformiongo.readme.io/reference/workplace-search

Example of a POST request body for the Workplace Search endpoint. It includes parameters for filtering and sorting search results.

```json
{
  "BusinessName": "Hot Dog Stand",
  "skip": 0,
  "sort": "business_name desc",
  "QueryCriteria": [
    {
      "Field": "BusinessName",
      "Operator": "Or",
      "Values": [
        "Hot Dog"
      ]
    },
    {
      "Field": "State",
      "Operator": "Not",
      "Values": [
        "CA"
      ]
    }
  ],
  "ResultsPerPage": 1,
  "Includes": [],
  "FilterOptions": []
}
```

--------------------------------

### Add Subscription Search Request Example

Source: https://enformiongo.readme.io/reference/add-subscription-search

This example demonstrates the structure of a JSON request body for adding a subscription search. It includes client identifiers, alert type, and Tahoe IDs.

```json
{
  "clientId": "9b0375f5-5053-465f-8086-08d98f38f1cd",
  "subClientId": "",
  "alertType": "AnyNewSurname",
  "tahoeIds": [
    "G-8919454502083151475"
  ]
}
```

--------------------------------

### Initial Address Object Example

Source: https://enformiongo.readme.io/reference/business-search

This snippet shows the first example of an address object in the OpenAPI definition. It details fields like address type, status, and specific address components.

```json
{
                            "addressType": "1",
                            "addressTypeDesc": "OFFICER 4 Test
                            "addressTypeId": "17",
                            "barCode": "/9581467Test8/",
                            "carrierRoute": "C030",
                            "checkDigit": "8",
                            "commercialFlag": "True",
                            "dp": "21",
                            "dpUnknown": "-21",
                            "dpc": "21",
                            "errorNumber": "A1",
                            "ffApplied": "",
                            "financeNumber": "056678",
                            "lacs": "",
                            "lot": "0069",
                            "matchFlag": "",
                            "moveDate": "",
                            "moveType": "",
                            "nbfRecordNo": "18960_20050616",
                            "nbfSourceId": "23477",
                            "nxi": "",
                            "poBoxFlag": "False",
                            "residentialFlag": "False",
                            "status": "V",
                            "timeZone": "PST",
                            "city": "Test",
                            "state": "WA",
                            "zip": "98122",
                            "county": "King",
                            "houseNumber": "1812",
                            "streetName": "19th",
                            "streetPostDirection": "",
                            "streetPreDirection": "",
                            "unit": "312",
                            "unitType": "Apt",
                            "addressLine1": "1812 19th, Apt 312",
                            "addressLine2": "Seattle, WA 98122",
                            "fullAddress": "1812 19th, Apt 312; TestWA 98122"
                        }
```

--------------------------------

### Example API Response

Source: https://enformiongo.readme.io/reference/professional-license-search

This is an example of a successful API response for a license search. It includes business details, counts, pagination information, database query details, and execution statistics.

```json
{
  "businesses": [
    {
      "businessId": -5317284065384000000,
      "businessName": "Acme Test Company"
    }
  ],
  "ownerName": null
},

],
"counts": {
  "searchResults": 8
},
"pagination": {
  "currentPageNumber": 1,
  "resultsPerPage": 20,
  "totalPages": 1
},
"databaseQueryInfo": [
  {
    "searchType": null,
    "hasIntermediateSort": null,
    "retryCount": null,
    "idCount": null,
    "matchRecordCount": null,
    "databaseQueries": [
      {
        "databaseConnectionTimeInMs": 1,
        "databaseQuery": "CALL search_license_criteria(@p_business_name := 'google f', @p_last_name := null, @p_first_name := null, @p_middle_name := null, @p_license_type := null, @p_license_number := null, @p_street_address := null, @p_house_number := null, @p_street_name := null, @p_unit := null, @p_city := null, @p_state := null, @p_zip_code := null, @p_poseidon_id_list := '', @p_tahoe_id := 0, @p_ssn := null, @p_retry_level := null, @p_uncompress := False, @p_record_limit := 20);",
        "executionTimeInMs": 9
      }
    ]
  }
],
"executionStatistics": [
  {
    "description": "ProLicense SP Client Search",
    "startTime": 3,
    "executionTimeInMs": 13
  },
  {
    "description": "CALL search_license_criteria",
    "startTime": 3,
    "executionTimeInMs": 10
  }
],
"searchCriteria": [],
"totalRequestExecutionTimeMs": 17,
"requestId": "4b0d9e1a-607d-4ff7-86e7-e79eb1804ab8",
"requestType": "ProLicense",
"requestTime": "2017-08-24T17:07:50.1469582-07:00",
"isError": false
}
```

--------------------------------

### Search API Response Example (200 OK)

Source: https://enformiongo.readme.io/reference/search-3

An example of a successful response from the Search API, indicating a match with detailed scoring information.

```json
{
    "matches": [
        {
            "tahoeId": "G895684409dfdsadf",
            "calculatedAge": "42",
            "matchScore": 98.31,
            "scoreDescriptions": [
                "ADDRESS_MATCH",
                "FULL_NAME_MATCH",
                "FULL_DOB_MATCH",
                "PREV_FULL_PHONE_MATCH",
                "FULL_EMAIL_MATCH",
                "NA",
                "NA",
                "NA"
            ],
            "scoreCategory": 5,
            "categoryDescription": "Excellent Match (all elements match or partially match)"
        }
    ]
}
```

--------------------------------

### Business Search Request Example

Source: https://enformiongo.readme.io/reference/business-search

Example of a JSON request body for searching businesses. Specify business name, page number, and results per page.

```json
{
  "BusinessName": "Hot dog stand",
  "Page": 1,
  "ResultsPerPage": 10
}
```

--------------------------------

### Business Search Response Example

Source: https://enformiongo.readme.io/reference/business-search

Example of a JSON response for a business search. Includes business records with details like IDs, filings, contacts, and addresses.

```json
{
    "businessV2Records": [
        {
            "poseidonId": -867713489171411111,
            "uccFilings": [],
            "newBusinessFilings": [
                {
                    "poseidonId": -8677134891714748323,
                    "businessId": "97063695",
                    "businessUrl": null,
                    "dbaNameId": null,
                    "nbfSourceId": null,
                    "company": Test
                    "contacts": [
                        {
                            "companyFlag": "False",
                            "contactId": "10932157",
                            "contactTypeDesc": "OFFICER 5",
                            "contactTypeId": "18",
                            "genderId": null,
                            "genderTypeDesc": null,
                            "name": {
                                "firstName": "",
                                "fullName": Test
                                "lastName": Test
                                "middleInit": "",
                                "suffix": ""
                            },
                            "nbfRecordNo": "18960_20050633",
                            "nbfSourceId": "23477",
                            "titleId": "244",
                            "tahoeId": null,
                            "officerTitleDesc": "CONTACT",
                            "officerTitleId": "244",
                            "ethnicTypeDesc": null,
                            "ethnicId": null
                        }
                    ],
                    "addresses": [
                        {
                            "addressType": "1",
                            "addressTypeDesc": "OFFICER 5 ADDRESS",
                            "addressTypeId": "18",
                            "barCode": "/9581467Test8/",
                            "carrierRoute": "C030",
                            "checkDigit": "8",
                            "commercialFlag": "True",
                            "dp": "21",
                            "dpUnknown": "-21",
                            "dpc": "87",
                            "errorNumber": "A1",
                            "ffApplied": "",
                            "financeNumber": "056678",
                            "lacs": "",
                            "lot": "0069",
                            "matchFlag": "",
                            "mov"
                        }
                    ]
                }
            ]
        }
    ]
}
```

--------------------------------

### Get Alert Request Structure

Source: https://enformiongo.readme.io/reference/get-alert

This snippet shows the required headers and an example of the request body for the Get Alert API. It includes setting the access profile, username, and search type, along with optional pagination parameters.

```APIDOC
## GET /alerts

### Description
Retrieves alerts based on provided search criteria and pagination rules.

### Method
GET

### Endpoint
/alerts

### Headers
- **galaxy-ap-name**: [Access Profile Name] - Required
- **galaxy-ap-password**: [Access Profile Password] - Required
- **galaxy-client-session-id**: (Optional) Session ID for logging
- **galaxy-client-type**: [Galaxy Client Type] - Required for Javascript clients
- **galaxy-search-type**: DataAlertsGetAlert - Required

### Request Body
```json
{
  "clientId": "9b0375f5-5053-465f-8086-08d98f38e5cd",
  "subClientId": "",
  "alertType": "NewBestPublicAddress",
  "tahoeIds": [
    "G-XXXXXXXXXXXXXXXXXX1",
    "G-XXXXXXXXXXXXXXXXXX2",
    "G-XXXXXXXXXXXXXXXXXX3"
  ],
  "sinceDate": "",
  "Page": 1,
  "ResultsPerPage": 10
}
```

### Optional Search with TahoeID Only
If you would like to perform a search with TahoeID only, you must pass the "TahoeIdSearch" Includes.

```json
{
 "TahoeIds": ["G-###################"] ,
 "Includes":
 ["TahoeIdSearch"]
}
```

### Response
(Success response details not provided in the source text)

### Error Handling
(Error handling details not provided in the source text)
```

--------------------------------

### API Error Response Example (400)

Source: https://enformiongo.readme.io/reference/contact-id-search

This example shows an empty JSON object returned for a 400 Bad Request error, indicating an issue with the request parameters.

```json
{}
```

--------------------------------

### Address Object Example

Source: https://enformiongo.readme.io/reference/business-search

This snippet shows an example of an address object within the OpenAPI definition. It includes fields for address type, location details, and status.

```json
{
                            "addressType": "1",
                            "addressTypeDesc": "OFFICER 4 Test
                            "addressTypeId": "17",
                            "barCode": "/9581467Test8/",
                            "carrierRoute": "C030",
                            "checkDigit": "8",
                            "commercialFlag": "True",
                            "dp": "21",
                            "dpUnknown": "-21",
                            "dpc": "21",
                            "errorNumber": "A1",
                            "ffApplied": "",
                            "financeNumber": "056678",
                            "lacs": "",
                            "lot": "0069",
                            "matchFlag": "",
                            "moveDate": "",
                            "moveType": "",
                            "nbfRecordNo": "18960_20050616",
                            "nbfSourceId": "23477",
                            "nxi": "",
                            "poBoxFlag": "False",
                            "residentialFlag": "False",
                            "status": "V",
                            "timeZone": "PST",
                            "city": Test
                            "state": "CA",
                            "zip": "95811",
                            "county": Test
                            "houseNumber": "Test",
                            "streetName": "Q",
                            "streetPostDirection": "",
                            "streetPreDirection": "",
                            "unit": "",
                            "unitType": "",
                            "addressLine1": TestQ",
                            "addressLine2": TestCA 95811",
                            "fullAddress": TestQ; test, CA 95811"
                        }
```

--------------------------------

### Marriage Search API Request Example

Source: https://enformiongo.readme.io/reference/marriage-search

This example demonstrates the structure of a request payload for searching marriage records. It includes parameters for name, state, pagination, and desired information inclusions.

```json
{
  "FirstName": "John",
  "LastName": "Smith",
  "State": "CA",
  "Page": 1,
  "ResultsPerPage": 10,
  "Includes": [
    "DatabaseQueryInfo",
    "ExecutionTimeInfo"
  ],
  "FilterOptions": []
}
```

--------------------------------

### Census Record Example

Source: https://enformiongo.readme.io/reference/census-search

This example demonstrates the structure of a census record, including personal details, address information, and relatives. It is useful for understanding the data returned by the API.

```json
{
            "eName": "00542",
            "imageNbr": null,
            "imageType": null,
            "lineNumber": "72",
            "naraFilm": null,
            "naraPublicationNumber": null,
            "naraRoll": null,
            "naraRollNumber": null,
            "naraSeries": null,
            "numericImageNbr": null,
            "orderOnPage": null,
            "packet": null,
            "packetLtr": null,
            "page": null,
            "pageChar": null,
            "pageOrig": null,
            "pid": null,
            "pidNumber": null,
            "recNbr": null,
            "recNbrPadded": null,
            "recNumber": null,
            "recordGroup": null,
            "recordId": null,
            "recordNbr": null,
            "recordNumber": null,
            "refId": null,
            "sequenceOrder": null,
            "sequenceOrderSuffix": null,
            "sheetLtr": null,
            "sheetNumber": null,
            "sheetNumberLetter": null,
            "udeBatchNumber": null,
            "batchId": null,
            "dgsImageId": null,
            "lineNbr": null,
            "imageId": null,
            "pageNumber": "5B"
          },
          "addressInfo": {
            "city": "",
            "state": "NY",
            "county": "ALBANY",
            "birthLocation": "NY",
            "birthLocationFather": null,
            "birthLocationMother": null,
            "birthLocationSpouse": null
          },
          "relatives": [
            {
              "censusYear": 1940,
              "householdId": 114,
              "relativeRelationship": "Daughter",
              "extraInfo": {
                    "ageFormatted": "8",
                    "canRead": null,
                    "canWrite": null,
                    "citizenshipStatus": null,
                    "cityResidedIn1935": null,
                    "citySameHouse": "SAME HOUSE",
                    "deathDateStd": null,
                    "dwelling": null,
                    "enumerationDist": null,
                    "enumerationDistrict": "1-17",
                    "estimatedMarriageYear": null,
                    "ethnicity": "W",
                    "eventDistrict": null,
                    "familyNumber": null,
                    "famNew": null,
                    "freeOrSlave": null,
                    "fullName": "ANDREW SMITH",
                    "idSuffix": null,
                    "immigrationYearOrig": null,
                    "immigrationYearStd": null,
                    "incorporatedPlace": null,
                    "institutions": null,
                    "language": null,
                    "minorCivilDivision": null,
                    "mthrHowManyChildren": null,
                    "newFamNew": null,
                    "newDwell": null,
                    "numberLivingChildren": null,
                    "ownRent": null,
                    "prAgeMonths": null,
                    "prOccupation": null,
                    "race": "W",
                    "regionKode": null,
                    "relationshipGroup": null,
                    "relMerge": null,
                    "respondent": null,
                    "scheduleType": null,
                    "stateResidedIn1935": "\r",
                    "temporarilyAbsent": null,
                    "tgnRecordId": null,
                    "tgnRelId": null,
                    "townCodeHex": null,
                    "townIsolated": null,
                    "unincorporatedPlace": null,
                    "ward": null
                    }
                }
            ]
        }
```

--------------------------------

### Example API Response Schema

Source: https://enformiongo.readme.io/reference/search-1

This snippet shows an example of a successful API response, detailing contact information such as phone numbers and emails. It includes fields for connection status and reporting dates.

```json
{
                "number": "(723) 132-5555",
                "type": "landline",
                "isConnected": true,
                "firstReportedDate": "8/15/2019",
                "lastReportedDate": "8/15/2019"
            },
            {
                "number": "(925) 111-4444",
                "type": "mobile",
                "isConnected": true,
                "firstReportedDate": "1/15/2023",
                "lastReportedDate": "1/15/2023"
            }
        ],
        "emails": [
            {
                "email": "test@test.com",
                "isValidated": false,
                "isBusiness": true
            },
            {
                "email": "test1@test.com",
                "isValidated": false,
                "isBusiness": true
            },
            {
                "email": "test2@test.la",
                "isValidated": false,
                "isBusiness": true
            },
            {
                "email": "test3@test.la",
                "isValidated": false,
                "isBusiness": true
            }
        ]
    },

```

--------------------------------

### Get Subscription Request

Source: https://enformiongo.readme.io/reference/get-subscription

This snippet shows how to construct a request to the Get Subscription API, including necessary headers and the request body with search criteria and pagination rules.

```APIDOC
## Get Subscription

### Description
Retrieves subscription details based on provided criteria.

### Headers
- `galaxy-ap-name`: [Access Profile Name]
- `galaxy-ap-password`: [Access Profile Password]
- `galaxy-client-session-id`: (Optional) Session ID for logging
- `galaxy-client-type`: [Galaxy Client Type] (required for Javascript clients)
- `galaxy-search-type`: DataAlertsGetSubscription

### Request Body
#### Search Criteria
```json
{
  "clientId": "9b0375f5-5053-465f-8086-08d98f38e5cd",
  "subClientId": "",
  "alertType": "NewBestPublicAddress",
  "tahoeIds": [
    "G-XXXXXXXXXXXXXXXXXX1",
    "G-XXXXXXXXXXXXXXXXXX2",
    "G-XXXXXXXXXXXXXXXXXX3"
  ]
}
```

#### Pagination Rules (Optional)
If not specified, defaults to 1000 results per page.
```json
{
  "clientId": "9b0375f5-5053-465f-8086-08d98f38e5cd",
  "subClientId": "",
  "alertType": "NewBestPublicAddress",
  "tahoeIds": [
    "G-XXXXXXXXXXXXXXXXXX1",
    "G-XXXXXXXXXXXXXXXXXX2",
    "G-XXXXXXXXXXXXXXXXXX3"
  ],
  "Page": 1,
  "ResultsPerPage": 10
}
```
```

--------------------------------

### Contact ID Search API Response Example

Source: https://enformiongo.readme.io/reference/contact-id-search

This example demonstrates a successful response from the Contact ID Search API, including contact details, emails, phone numbers, and metadata.

```json
{
    "data": {
        "contacts": [
            {
                "contactId": "c_12345",
                "firstName": "John",
                "lastName": "Doe",
                "phones": [
                    {
                        "number": "(555) 123-4567",
                        "type": "mobile",
                        "isConnected": true,
                        "firstReportedDate": "2/3/2006",
                        "lastReportedDate": "2/3/2006"
                    },
                    {
                        "number": "(555) 555-5555",
                        "type": "landline",
                        "isConnected": true,
                        "firstReportedDate": "5/1/2000",
                        "lastReportedDate": "5/15/2000"
                    }
                ],
                "emails": [
                    {
                        "email": "testemail@gmail.com",
                        "isValidated": false,
                        "isBusiness": false
                    },
                    {
                        "email": "testemail2@netscape.net",
                        "isValidated": false,
                        "isBusiness": false
                    }
                ]
            }
        ],
        "message": "",
        "pagination": {
            "currentPageNumber": 1,
            "resultsPerPage": 1,
            "totalPages": 1,
            "totalResults": 0
        },
        "databaseQueryInfo": [],
        "searchCriteria": [],
        "totalRequestExecutionTimeMs": 77,
        "requestId": "4a2f2if-cb34-4832-813f-c9f2jf9sj23",
        "requestType": "DevAPIContactID",
        "requestTime": "2023-08-28T16:25:02.7807414-07:00",
        "isError": false,
        "error": {
            "inputErrors": [],
            "warnings": []
        }
    }
}
```

--------------------------------

### Reverse Phone Search Request Example

Source: https://enformiongo.readme.io/reference/reverse-phone-search

This example demonstrates the structure of a request to the Reverse Phone Search endpoint. It includes parameters for the phone number, desired data inclusions, filter options, and pagination.

```json
{
  "Phone": "123-456-7890",
  "Includes": [
    "FullRecord",
    "DatabaseQueryInfo",
    "Sources"
  ],
  "FilterOptions": [
    "IncludePrivateData",
    "IncludeOptOutData",
    "IncludeAllDataSources",
    "IncludeResultsWithMissingNames",
    "DisplayNpaResults",
    "EnableThirdPartyDataSourceLookup"
  ],
  "Page": 1,
  "ResultsPerPage": 10
}
```

--------------------------------

### Marriage Search API Response Example

Source: https://enformiongo.readme.io/reference/marriage-search

This example shows the structure of a successful response when searching for marriage records. It contains an array of 'records', each detailing marriage information such as spouse names, marriage date, and location.

```json
{
  "records": [
    {
      "posiedonId": "XXXXXXXX",
      "spouseKey": "SpouseKey",
      "spouseGender": "Male",
      "spouseFirstName": "FirstName",
      "spouseMiddleName": "MiddleName",
      "spouseLastName": "LastName",
      "spouseNameSuffix": "",
      "spouseMaidenName": "",
      "spouseAge": 25,
      "otherSpouseFirstName": "FirstName",
      "otherSpouseMiddleName": "MiddleName",
      "otherSpouseLastName": "LastName",
      "otherSpouseNameSuffix": "",
      "otherSpouseAge": 24,
      "otherSpouseFullName": "FirstName MiddleName LastName",
      "marriageDate": "M/DD/YYYY",
      "divorceDate": "0",
      "certificatNo": "UNKNOWN",
      "recordType": "M",
      "state": "Ca",
      "county": "Sacramento",
      "recordSubType": "",
      "decree": "0",
      "fileId": "",
      "caseBookId": ""
    }
  ]
}
```

--------------------------------

### Example API Response Data

Source: https://enformiongo.readme.io/reference/search-2

This snippet shows an example of the data structure returned for phone numbers and emails in an API response. It includes details like the number/email, type, connection status, and reporting dates.

```json
{
                "number": "(723) 111-9154",
                "type": "landline",
                "isConnected": true,
                "firstReportedDate": "8/15/2019",
                "lastReportedDate": "8/15/2019"
            },
            {
                "number": "(925) 111-4354",
                "type": "mobile",
                "isConnected": true,
                "firstReportedDate": "1/15/2023",
                "lastReportedDate": "1/15/2023"
            }
        ],
        "emails": [
            {
                "email": "testc@dreamerswanted.com",
                "isValidated": false,
                "isBusiness": true
            },
            {
                "email": "test@dreamerswanted.com",
                "isValidated": false,
                "isBusiness": true
            },
            {
                "email": "test@wedesign.la",
                "isValidated": false,
                "isBusiness": true
            },
            {
                "email": "test@wedesign.la",
                "isValidated": false,
                "isBusiness": true
            }
        ]
    }
```

--------------------------------

### Reverse Phone Search Response Example

Source: https://enformiongo.readme.io/reference/reverse-phone-search

This example shows a successful response from the Reverse Phone Search endpoint. It includes details such as the phone number, associated addresses, names, carrier information, and data source details.

```json
{
  "PhoneNumber": "(123) 456-7890",
  "Addresses": [
    {
      "HouseNumber": "5555",
      "StreetPreDirection": "",
      "StreetName": "Some Street",
      "StreetPostDirection": "",
      "StreetType": "",
      "Unit": "",
      "UnitType": null,
      "City": "Some City",
      "State": "CA",
      "Zip": "12345",
      "Zip4": "1234",
      "FullAddress": "5555 Some Steet; Some City, CA 12345-1234"
    }
  ],
  "Names": [
    {
      "Prefix": "Mr",
      "FirstName": "XYZ",
      "MiddleName": "ABC",
      "LastName": "PQR",
      "Suffix": ""
    }
  ],
  "Carrier": "POWERTEL ATLANTA LICENSES, INC.",
  "PhoneType": "Cell",
  "TimeZone": "Eastern",
  "Latitude": "55.5555",
  "Longitude": "-55.5555",
  "RecordId": "G1234567890123456789",
  "DataSource": "Tahoe",
  "SecondaryDataSource": null,
  "FirstReportedDate": "2/7/2010",
  "LastReportedDate": "12/5/2016",
  "FullRecord": null
}
```

--------------------------------

### Get All Industries

Source: https://enformiongo.readme.io/reference/get-industries

This endpoint returns all possible industries for which we have data. It is a GET request to the /WorkplaceSearch/GetIndustries endpoint.

```APIDOC
## GET /WorkplaceSearch/GetIndustries

### Description
This request returns all possible Industries we have data for.

### Method
GET

### Endpoint
/WorkplaceSearch/GetIndustries

### Request Example
```json
{
}
```

### Response
#### Success Response (200)
- **searchRecords** (array) - A list of industry strings.
```

--------------------------------

### Get States API Response

Source: https://enformiongo.readme.io/reference/drilldown-search

This is a sample JSON response from the Get States endpoint. It includes a list of state abbreviations, record counts, and pagination details.

```json
{
    "searchRecords": [
        "AA",
        "AB",
        "AE",
        "AK",
        "AL",
        "AP",
        "AR",
        "AS",
        "AZ",
        "BC",
        "CA",
        "CO",
        "CT",
        "DC",
        "DE",
        "FL",
        "FM",
        "GA",
        "GU",
        "HI",
        "IA",
        "ID",
        "IL",
        "IN",
        "KS",
        "KY",
        "LA",
        "MA",
        "MB",
        "MD",
        "ME",
        "MH",
        "MI",
        "MN",
        "MO",
        "MP",
        "MS",
        "MT",
        "NB",
        "NC",
        "ND",
        "NE",
        "NH",
        "NJ",
        "NL",
        "NM",
        "NS",
        "NT",
        "NU",
        "NV",
        "NY",
        "OH",
        "OK",
        "ON",
        "OR",
        "PA",
        "PE",
        "PQ",
        "PR",
        "PW",
        "QC",
        "RI",
        "SC",
        "SD",
        "SK",
        "TN",
        "TX",
        "UT",
        "VA",
        "VI",
        "VT",
        "WA",
        "WI",
        "WV",
        "WY",
        "YT",
        "ZZ"
    ],
    "responseRecordCount": 77,
    "pagination": {
        "currentPageNumber": 0,
        "resultsPerPage": 0,
        "totalPages": 0
    },
    "searchCriteria": [],
    "totalRequestExecutionTimeMs": 695,
    "requestId": "25aa5ca7-ba9c-46d4-b9dd-9f0eb8cf6a48",
    "requestType": "Search",
    "requestTime": "2022-01-24T13:30:14.3088953-06:00",
    "isError": false
}
```

--------------------------------

### Search Criteria for Eviction Search

Source: https://enformiongo.readme.io/reference/eviction

Define the search parameters, such as business name, and specify which information to include in the response. This example sets the page number and results per page.

```json
{
    "BusinessName": "dulaney",
    "Includes": ["DatabaseQueryInfo", "ExecutionTimeInfo"],
    "Page": 1,
    "ResultsPerPage": 20
}
```

--------------------------------

### Example Push Notification Payload

Source: https://enformiongo.readme.io/reference/add-push-notifications

This is an example of the JSON payload structure for push notifications, detailing client information, subscription dates, and records with associated alerts.

```text
{
    "ClientId": "db79e37f-56e3-4fd8a-e6ab-5426c1230f9",
    "SubClientId": "26ec9129-85dc-4db0-adf3-fae50bd51095",
    "SinceDate": "11/1/2021",
    "Records": [
        {
            "TahoeId": "G-XXXXXXXXXXXXXXXXXXX",
            "Alerts": [
                {
                    "Hash": "-213456783",
                    "IsPublic": false,
                    "GeneratedDate": "12/17/2021",
                    "AlertType": "AnyNewAddress"
                }
            ]
        },
        {
            "TahoeId": "G9216439176547323168",
            "Alerts": [
                {
                    "Hash": "-1234567160",
                    "IsPublic": false,
                    "GeneratedDate": "11/30/2021",
                    "AlertType": "AnyNewSurname"
                }
            ]
        },
        {
            "TahoeId": "G9220154662871533952",
            "Alerts": [
                {
                    "Hash": "212753457",
                    "IsPublic": false,
                    "GeneratedDate": "11/30/2021",
                    "AlertType": "AnyNewAddress"
                },
                {
                    "Hash": "-784345833",
                    "IsPublic": false,
                    "GeneratedDate": "11/30/2021",
                    "AlertType": "AnyNewSurname"
                }
            ]
        }
    ]
}
```

--------------------------------

### Sample Response for Get Levels (Regional)

Source: https://enformiongo.readme.io/reference/get-levels-regional

The response contains a list of management levels found, the count of records, and pagination details. It also includes request metadata and error status.

```json
{
    "searchRecords": [
        "C-LEVEL",
        "DIRECTOR-LEVEL",
        "MANAGER-LEVEL",
        "OTHER",
        "SELF-EMPLOYED",
        "STAFF",
        "UNEMPLOYED",
        "VP-LEVEL"
    ],
    "responseRecordCount": 8,
    "pagination": {
        "currentPageNumber": 0,
        "resultsPerPage": 0,
        "totalPages": 0
    },
    "searchCriteria": [],
    "totalRequestExecutionTimeMs": 417,
    "requestId": "928d8d7f-696c-48e9-af85-575f2b674f59",
    "requestType": "Search",
    "requestTime": "2022-01-24T14:11:08.0497677-06:00",
    "isError": false
}
```

--------------------------------

### OpenAPI Definition Example

Source: https://enformiongo.readme.io/reference/pre-foreclosure-search

This snippet shows a portion of an OpenAPI definition, illustrating the structure for property and borrower data. It includes fields for deed information, situs address, and borrower details.

```json
": {
                "etalCode": "",
                "etalLabel": "Unspecified",
                "situsMode": "ST",
                "situsQuadrant": "",
                "deedCode": "L",
                "deedLabel": "Lis Pendens"
            },
            "siteAddress": {
                "md9Hash": 8614591860115078950,
                "houseNumber": "1410",
                "streetDirection": "",
                "streetName": "Amsterdam",
                "streetType": "ST",
                "unitType": "",
                "unit": "",
                "streetPostDirection": "",
                "city": "Mena",
                "state": "AR",
                "county": "Polk",
                "zipCode": "71953",
                "zip4": "4453",
                "latitude": 34.574541,
                "longitude": -94.235747,
                "verificationCodes": "AS01",
                "addressLine1": "1410 Amsterdam St",
                "addressLine2": "Mena, AR 71953-4453",
                "fullAddress": "1410 Amsterdam St; Mena, AR 71953-4453"
            },
            "borrowers": [
                {
                    "md5Hash": -1388233891121179990,
                    "firstName": "Jason",
                    "middleName": "A",
                    "lastName": "Mckee",
                    "suffix": "",
                    "companyName": "",
                    "recordingDate": "02/02/2018",
                    "addressHashMD9": 8614591860115078950,
                    "tahoeId": "G7147579687241339179"
                },
                {
                    "md5Hash": 8682102257688478797,
                    "firstName": "Joni",
                    "middleName": "L",
                    "lastName": "Mckee",
                    "suffix": "",
                    "companyName": "",
                    "recordingDate": "02/02/2018",
                    "addressHashMD9": 8614591860115078950,
                    "tahoeId": "G-5721738385966093580"
                },
                {
                    "md5Hash": -4391228171943227088,
                    "firstName": "Synchrony",
                    "middleName": "",
                    "lastName": "Bank Of Walmart",
                    "suffix": "",
                    "companyName": "Synchrony Bank of Walmart",
                    "recordingDate": "02/02/2018",
                    "addressHashMD9": 8614591860115078950,
                    "tahoeId": null
                },
                {
                    "md5Hash": 4788735089425669987,
                    "firstName": "Natl",
                    "middleName": "Bk Of Paris",
                    "lastName": "First",
                    "suffix": "",
                    "companyName": "First Natl. Bk. of Paris",
                    "recordingDate": "02/02/2018",
                    "addressHashMD9": 8614591860115078950,
                    "tahoeId": null
                }
            ],
            "lender": {
                "address": {
                    "md9Hash": 0,
                    "houseNumber": "",
                    "streetDirection": "",
                    "streetName": "",
                    "streetType": "",
                    "unitType": "",
                    "unit": "",
                    "streetPostDirection": "",
                    "city": "",
                    "state": "",
                    "county": "",
                    "zipCode": "",
                    "zip4": "",
                    "latitude": 999.9,
                    "longitude": 999.9,
                    "verificationCodes": "",
                    "addressLine1": "",
                    "addressLine2": "",
                    "fullAddress": ""
                },
                "md5Hash": 0,
                "firstName": "",
                "middleName": "",
                "lastName": "",
                "suffix": "",
                "companyName": "",
                "recordingDate": "02/02/2018",
                "addressHashMD9": 8614591860115078950,
                "tahoeId": null
            },
            "trustee": {
                "address": {
                    "md9Hash": 0,
                    "houseNumber": "",
                    "streetDirection": "",
                    "streetName": "",
                    "streetType": "",
                    "unitType": "",
                    "unit": "",
                    "streetPostDirection": "",
                    "city": "",
                    "state": "",

```
Tokens:
Raw