Data Dictionary
Reverse Phone API
Response Field | Description |
|---|---|
ID | The persistent ID of the phone number/address/person returned. |
Phone Number | The phone number normalized and formatted with a country code. |
Is Valid | Boolean indicator if the phone syntax is correct. |
Country Calling Code | The country code for the phone number. |
Line Type | Line type indicating if the phone is Landline, Mobile, Fixed or NonFixedVOIP (like a Twilio or Google Voice), TollFree, etc. |
Carrier | The MVNO level carrier provides the service to the subscriber. |
Is Prepaid | Boolean indicator if the phone number is associated with a prepaid account. |
Is Commercial | Boolean indicator if the phone number is registered to a business. |
Belongs To | The primary owner of the phone. In the case of family plans, additional owners associated with this phone are also provided in the associated_people attribute, categorized as ‘PotentialOwner’. |
Age | Age range of the phone subscriber. |
Gender | Gender of the phone subscriber. |
Industry | If the phone is registered to the business, the industry of the business (E.g., Retail, Automotive, etc.) |
Phone Link Date | The date since when the phone has been associated to the subscriber. |
Current Addresses | Current address of the subscriber, including full address, postal code, geocoordinates and the date since when the subscriber is associated to the address. |
Historical Addresses | A list of historical addresses associated with the phone subscriber, including full address, postal code, geocoordinates and the dates when the subscriber was associated to the address. |
Associated People | Associated people living in the same household, as well as relatives to the phone subscriber. |
Alternate Phones | The list of alternate phone numbers of the primary owner. |
Caller Identification (CNAM) API
Response Field | Field Type | Examples | Description |
|---|---|---|---|
ID | String or Null | The persistent ID of the phone number/address/person returned. | |
Phone Number | String or Null | A unique phone number with a country code. The default country code is +1 (USA). | |
Is Valid | Boolean or Null | True if the phone number or address is valid. | |
Country Calling Code | String or Null | +1 (USA) | The country code for the phone number. |
Line Type | String or Null | Landline | Traditional wired phone. |
Mobile | Wireless phone provided by a mobile carrier. | ||
Fixed VOIP | Phone numbers linked to a physical address, such as Comcast. | ||
Non-Fixed VOIP | Phone numbers over the internet, such as Skype and Whatsapp. | ||
Premium | Caller pays for a premium for the call (e.g., 1-900...). | ||
Toll-Free | The call is free for the caller (e.g., 1-800...). | ||
Voicemail | Voicemail-only service. | ||
Other | Line type is unclear or does not match categories. | ||
Carrier | String or Null | The MVNO level carrier provides the service to the subscriber. | |
Is Prepaid | Boolean or Null | True if the phone number is associated with a prepaid account. | |
Is Commercial | Boolean or Null | True if the phone number is registered to a business. | |
Belongs To | Object or Null | The primary owner of the phone. | |
Current Addresses | Array of Objects | A list of unique addresses associated with a person. | |
Error | Object | ||
Warnings | Array of Strings | Invalid/Missing Input | Contains warning messages. |
Reverse Address API
Response Field | Field Type | Examples | Description |
|---|---|---|---|
ID | String or Null | The persistent ID of the phone number/address/person returned. | |
Is Valid | Boolean or Null | True if the address is valid. | |
Street Line 1 | String or Null | The first line of the street part in a structured address. | |
Street Line 2 | String or Null | The second line of the street part in a structured address. | |
City | String or Null | The name of the city in the structured address. | |
Postal Code | String or Null | The postal code of a structured address. | |
Zip4 | String or Null | The ZIP+4 code of the structured address (USA). | |
State Code | String or Null | The state code of the structured address. | |
Country Code | String or Null | .us (United States), .fr (France), .de (Germany) | Internationally recognized country codes. It's basically an acronym that stands for a country or state. |
Lat/Long | Object | The coordinates of the geographical location of the address. | |
Is Active | Boolean or Null | True if the address is currently receiving mail. | |
Is Commercial | Boolean or Null | True if the address is a business address. | |
Is Forwarder | Boolean or Null | True if the address is performing freight forwarding or reshipping services. Forwarders most likely will send the goods outside of the country. | |
Delivery Point | String or Null | The type of the delivery point of the address. | |
Current Residents | Array of Objects | The list of current person and business residents at the address. | |
Last Sale Date | String or Null | The date of the last sale of the property. US addresses only. | |
Total Value | Integer of Null | The total assessed tax value of the property in USD. US addresses only. | |
Owners | Array of Objects | The list of current owners of the property. US addresses only. | |
Associated Addresses | Array of Objects | The list of associated addresses. | |
Error | Object | ||
Warnings | Array of Strings | Invalid/Missing Input | Contains warning messages. |
Find Person API
Response Field | Field Type | Examples | Description |
|---|---|---|---|
ID | String or Null | The persistent ID of the phone number/address/person returned. | |
Current Addresses | Array of Objects | A list of unique addresses associated with a person. | |
Historical Addresses | Array of Objects | A list of historical addresses associated with a person. | |
Associated People | Array of Objects | The list of related and associated people to a person or business. | |
Error | Object | ||
Warnings | Array of Strings | Invalid/Missing Input | Contains warning messages. |
Country Code | String or Null | .us (United States), .fr (France), .de (Germany) | Internationally recognized country codes. It's basically an acronym that stands for a country or state. |
Street Line 1 | String or Null | The first line of the street part in a structured address. | |
Street Line 2 | String or Null | The second line of the street part in the structured address. | |
City | String or Null | The name of the city in the structured address. | |
Postal Code | String or Null | The postal code in the structured address. | |
Zip 4 | String or Null | The zip+4 code in a structured address. | |
State Code | String or Null | The state code in the structured address. | |
Lat/Long | Object | The coordinates of the geographical location of the address. | |
Is Active | Boolean or Null | True if the address is currently receiving mail. | |
Count Person | Integer | The number of people returned. | |
Name | String or Null | The name of the person returned. | |
First Name | String or Null | The first name of the person returned. | |
Middle Name | String of Null | The middle name or the middle initial of the person returned. | |
Last Name | String or Null | The last name of the person returned. | |
Alternate Names | Array of Strings | Names associated with this person. | |
Age Range | String or Null | The age of the person in a five-year range. | |
Gender | String or Null | The gender of the person. | |
Found at Address | Object | The address of the person. | |
Phones | Array of Objects | The list of phone numbers associated with the business. |