InsuranceNow API (5.0.0)
InsuranceNow's RESTful API is built according to the OpenAPI specification and provides access to InsuranceNow functionality. Developers can use the API to integrate InsuranceNow with portals and other third-party systems.
Returns customer details.
Returns a list of customer details. Requires at least one of the following parameters:
indexName
taxId
contactNumber
emailAddress
applicationRef
createdSinceDate
recentlyViewed=true
customerNumber
query Parameters
address | string Lookup address of customer. |
applicationRef | string System identifier of the application. |
city | string Mailing, billing, or lookup city of customer. |
contactNumber | string Primary or secondary phone number, or fax number, of customer. |
continuationId | string Indicates the starting offset for the API results when you want to return a specific portion of the full results.
You can use this parameter with the limit parameter. For example, the limit on your first API call was 100 and the results populated a list on the page.
To request the next page of 100 results, call the API again with |
createdSinceDate | string <date> Customer creation date is equal to or greater than the provided createdSinceDate. |
customerNumber | string Customer-number of the customer. |
emailAddress | string Email address of customer. |
indexName | string Last name or first name of customer. |
limit | string Indicates the maximum number of results to return. |
optionalFields | string Comma-delimited list of optional fields to be included. Currently supports policyCount and openTaskCount. |
postalCode | string Mailing, billing, or lookup zipcode of customer. |
providerId | string Customer provider. |
recentlyViewed | boolean Find customers recently viewed by the caller or user. If true, results will be restricted to customers recently viewed by the caller or user. If false (or not provided), results will not be restricted to customers recently viewed by the caller or user. |
stateOrProv | string Mailing, billing, or lookup state of customer. |
taxId | string Tax Id, Tax Id Trust, Tax Id Estate, Social Security Number, or joint Social Security Number of customer. |
Responses
Response samples
- 200
- 400
- 500
{- "continuationId": "string",
- "customerListItems": [
- {
- "_links": [
- {
- "href": "string",
- "rel": "string"
}
], - "addDt": "2019-08-24",
- "addresses": [
- {
- "addition": "string",
- "additionalLegal": "string",
- "addr1": "string",
- "addr2": "string",
- "addr3": "string",
- "addr4": "string",
- "addrTypeCd": "ContactAddr",
- "addressHash": "string",
- "attention": "string",
- "barcodeDigits": "string",
- "block": "string",
- "carrierRoute": "string",
- "city": "string",
- "congressCode": "string",
- "county": "string",
- "countyCode": "string",
- "dpv": "string",
- "dpvDesc": "string",
- "dpvNotes": "string",
- "dpvNotesDesc": "string",
- "geocodeLevel": "string",
- "geocodeLevelDescription": "string",
- "id": "string",
- "latitude": "string",
- "legalDesc": "string",
- "longitude": "string",
- "lot": "string",
- "meridian": "string",
- "plssCounty": "string",
- "postDirectional": "string",
- "postalCode": "string",
- "preDirectional": "string",
- "primaryMeridian": "string",
- "primaryNumber": "string",
- "primaryNumberSuffix": "string",
- "range": "string",
- "rangeDir": "string",
- "regionCd": "string",
- "regionISOCd": "string",
- "score": "string",
- "secondaryDesignator": "string",
- "secondaryNumber": "string",
- "section": "string",
- "stateProvCd": "string",
- "streetName": "string",
- "suffix": "string",
- "township": "string",
- "townshipDir": "string",
- "validated": "string",
- "verificationHash": "string",
- "verificationMsg": "string"
}
], - "entityTypeCd": "string",
- "indexName": "string",
- "nameInfo": [
- {
- "commercialName": "string",
- "commercialName2": "string",
- "dbaIndexName": "string",
- "dbaName": "string",
- "extendedName": "string",
- "givenName": "string",
- "id": "string",
- "indexName": "string",
- "nameTypeCd": "ContactName",
- "otherGivenName": "string",
- "positionCd": "string",
- "prefixCd": "Ms",
- "shortName": "string",
- "suffixCd": "string",
- "surname": "string"
}
], - "openTaskCount": "string",
- "policyCount": "string",
- "ref": "string"
}
]
}
Was this page helpful?