Lifedata® API Overview
The Datafinder API enables programmatic use of Datafinder's various append services through a simple, RESTful API. JSON (default) and XML responses are provided. Both HTTP GET or HTTP POST are supported.
Phone and Email Append Overview
Datafinder's Phone and Email Append API service enables you to programmatically append complete contact information to your customer or prospect list. Fill in the missing contact information such as full names, email addresses, phone numbers, and postal addresses.
Our versatile API service allows multiple contact inputs including any combination of:
- Full Name
- Email Address
- Phone Number
- Postal Address
Our powerful matching engine enables you to provide various inputs and generate many combinations of outputs. In a summary, this API service supports:
- Email Append
- Reverse Email Append
- Phone Append
- Reverse Phone Append
- Postal Address Append
- Reverse Postal Address Append
Inputs and outputs:
For a complete list of inputs please see the "Parameters" section. For a complete list of outputs, please see the "Output Fields" section.
Request URL
Phone append
https://api.datamarket.azure.com/datafinder/phone-append/v1/
Email appendhttps://api.datamarket.azure.com/datafinder/email-append-preview/v1/
Parameters
Config Parameters
Use the config parameters to adjust elements like the output language.
| Name | Description |
|---|---|
| cfg_mc |
Specify the Match Codes required for a match to be returned Example:cfg_mc=E |
Search Parameters
Any parameter that begins with a "d_" is a search parameter. We will use these parameters to try and match an individual or household. Some search parameters will not return results if used by themselves, such as d_last or d_first. If a search parameter requires another, it will be noted in the table below.
NOTE: d_first and d_last are required for an individual level match; otherwise, a household level match is returned.
| Name | Description |
|---|---|
| d_first |
A first name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_first=john |
| d_last |
A last name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_last=Doe |
| d_fullname |
A first and last name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_fullname=john smith |
| d_zip |
A 5 digit zip code in the USA. Requires: d_fulladdr Example:d_zip=87402 |
| d_fulladdr |
Entire house number + street + suite (e.g. "7530 164th Ave NE, Ste A204") Requires: d_city,d_state or d_zip Example:d_fulladdr=123 lucky ln |
| d_city |
A city in the USA. Requires: d_fulladdr,d_state Example: d_city=Anaheim |
| d_state |
Two letter state abbreviation Requires: d_fulladdr,d_city or d_fulladdr,d_zip Example: d_state=CO |
| d_phone |
Ten digits NPANXXNNNN Example: d_phone=8003950164 |
| d_email |
Valid email address Example: d_email=account_name@domain.com |
| d_lat,d_long |
latitude / longitude Example: d_long=74.0059,d_lat=40.7127 |
Output Fields
Fields returned in the results:
| Name | Description |
|---|---|
| #RawScore | Represents how close the match is. |
| #WeightedScore | Weighted score that represents how close the match is. |
| #RawMatchCodes | See "Match Codes" section below |
| FirstName | A first name |
| MiddleName | A middle name |
| LastName | A last name |
| Address | A street address |
| City | A city |
| State | A state |
| Zip | A zip |
| Phone | A phone number |
| TimeStamp | The date and time at which the data for this data was saved. |
| EmailAddr | An email address |
| LineType | The line type of the phone number. NOTE: due to factors like number portability, there is a. |
| EmailAddrUsable | Returns a "YES" if this is a valid email address, otherwise this field is not present. |
Match Codes
Match Codes are returned in the results section and specify what input search parameters were used to find the matched record.
| Match Code | Match Type |
|---|---|
| L | LastName |
| F | FirstName |
| LF |
LF0 - First and Last name match LF1 - First and Last name appear swapped LF2 - Full name matches |
| E | EmailAddr |
| DOM | Email Domain |
| H | Social Handle |
| P | Phone |
| AHN | Address house number |
| AS | Address street |
| C | City |
| S | State |
| Z | Zip |
| ACSZ | If A and (C,S or Z) appear this flag will be set. |
| CS | City and State match |
| D | DOB or age |
| INDIV | Individual match. Individuals can be matched in many ways but all include some matching ocmponent to a first/last name or specific individual identifier such as Email. If you do not provide these minimums query parameters, an INDIV code will not appear. |
| HHLD | Household match. For this code to occur, a household must have been input (address/city/state) and name |
Consumer Alternate Contact Append Overview
Similar to our Contact Append, Datafinder's Consumer Alternate Contact Append API service provides you with additional email addresses, phone numbers and postal addresses associated with an individual. Through our API you can add additional email addresses, phone numbers and postal addresses by using the contact information you already have about your customer -- even if it is outdated or incorrect. Additionally, Datafinder adds timestamp with each appended attribute, allowing our API users to get a view of their customer's postal address history.
Inputs and outputs:
For a complete list of inputs please see the "Parameters" section. For a complete list of outputs, please see the "Output Fields" section.
Request URL
https://api.datamarket.azure.com/datafinder/consumer-alternate/v1/
Parameters
Config Parameters
Use the config parameters to adjust elements like the output language.
| Name | Description |
|---|---|
| cfg_mc |
Specify the Match Codes required for a match to be returned Example:cfg_mc=E |
Search Parameters
Any parameter that begins with a "d_" is a search parameter. We will use these parameters to try and match an individual or household. Some search parameters will not return results if used by themselves, such as d_last or d_first. If a search parameter requires another, it will be noted in the table below.
NOTE: d_first and d_last are required for an individual level match; otherwise, a household level match is returned.
| Name | Description |
|---|---|
| d_first |
A first name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_first=john |
| d_last |
A last name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_last=Doe |
| d_fullname |
A first and last name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_fullname=john smith |
| d_zip |
A 5 digit zip code in the USA. Requires: d_fulladdr Example:d_zip=87402 |
| d_fulladdr |
Entire house number + street + suite (e.g. "7530 164th Ave NE, Ste A204") Requires: d_city,d_state or d_zip Example:d_fulladdr=123 lucky ln |
| d_city |
A city in the USA. Requires: d_fulladdr,d_state Example: d_city=Anaheim |
| d_state |
Two letter state abbreviation Requires: d_fulladdr,d_city or d_fulladdr,d_zip Example: d_state=CO |
| d_phone |
Ten digits NPANXXNNNN Example: d_phone=8003950164 |
| d_email |
Valid email address Example: d_email=account_name@domain.com |
| d_lat,d_long |
latitude / longitude Example: d_long=74.0059,d_lat=40.7127 |
Output Fields
Output Fields
Fields returned in the results:
| Name | Description |
|---|---|
| #RawScore | Represents how close the match is. |
| #WeightedScore | Weighted score that represents how close the match is. |
| #RawMatchCodes | See "Match Codes" section below |
| FirstName | The first name found for matching record |
| MiddleName | The middle name found for matching record |
| LastName | The last name found for matching record |
| EmailAddr | The primary email address found for matching record |
| Phone | The primary phone number found for matching record |
| Address | The primary street address found for matching record |
| City | The primary city found for matching record |
| State | The primary state found for matching record |
| Zip | The primary zip found for matching record |
| TimeStamp | The date and time at which the data for the primary record was saved. |
| @EmailAddr | Alternate email addresses used by the primary record. Timestamp included for each address specifies the time and date at which this information was saved. |
| @Phone | Alternate phone numbers used by the primary record. Timestamp included for each address specifies the time and date at which this information was saved. |
| @FullAddr | Alternate street addresses used by the primary record. Timestamp included for each address specifies the time and date at which this information was saved. |
| @AssociatedPeople | People associated with the primary record. |
Match Codes
Match Codes are returned in the results section and specify what input search parameters were used to find the matched record.
| Match Code | Match Type |
|---|---|
| L | LastName |
| F | FirstName |
| LF |
LF0 - First and Last name match LF1 - First and Last name appear swapped LF2 - Full name matches |
| E | EmailAddr |
| DOM | Email Domain |
| H | Social Handle |
| P | Phone |
| AHN | Address house number |
| AS | Address street |
| C | City |
| S | State |
| Z | Zip |
| ACSZ | If A and (C,S or Z) appear this flag will be set. |
| CS | City and State match |
| D | DOB or age |
| INDIV | Individual match. Individuals can be matched in many ways but all include some matching ocmponent to a first/last name or specific individual identifier such as Email. If you do not provide these minimums query parameters, an INDIV code will not appear. |
| HHLD | Household match. For this code to occur, a household must have been input (address/city/state) and name |
Consumer Demographic Append Overview
Datafinder's Consumer Demographic Append API service allows you to input basic contact information from your CRM and append LifeData to your customer list. Gain insight into your customer's interests, purchase behavior, demographics and much more. In short, our API can be broken into 5 main categories of data:
- Demographic
- Financial and Household
- Lifestyle, Interest and Activities
- Automobile
- Education
Our API accepts a variety of inputs, including any combination of the following:
- Full Name
- Postal Address
- Phone Number
- Email Address
Request URL
https://api.datamarket.azure.com/datafinder/consumer-demo/v1/
Parameters
Config Parameters
Use the config parameters to adjust elements like the output language.
| Name | Description |
|---|---|
| cfg_mc |
Specify the Match Codes required for a match to be returned Example:cfg_mc=E |
Search Parameters
Any parameter that begins with a "d_" is a search parameter. We will use these parameters to try and match an individual or household. Some search parameters will not return results if used by themselves, such as d_last or d_first. If a search parameter requires another, it will be noted in the table below.
NOTE: d_first and d_last are required for an individual level match; otherwise, a household level match is returned.
| Name | Description |
|---|---|
| d_first |
A first name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_first=john |
| d_last |
A last name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_last=Doe |
| d_fullname |
A first and last name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_fullname=john smith |
| d_zip |
A 5 digit zip code in the USA. Requires: d_fulladdr Example:d_zip=87402 |
| d_fulladdr |
Entire house number + street + suite (e.g. "7530 164th Ave NE, Ste A204") Requires: d_city,d_state or d_zip Example:d_fulladdr=123 lucky ln |
| d_city |
A city in the USA. Requires: d_fulladdr,d_state Example: d_city=Anaheim |
| d_state |
Two letter state abbreviation Requires: d_fulladdr,d_city or d_fulladdr,d_zip Example: d_state=CO |
| d_phone |
Ten digits NPANXXNNNN Example: d_phone=8003950164 |
| d_email |
Valid email address Example: d_email=account_name@domain.com |
| d_lat,d_long |
latitude / longitude Example: d_long=74.0059,d_lat=40.7127 |
Output Fields
For a list of fields returned, please see the "Details" tab on the Azure Marketplace page.
Match Codes
Match Codes are returned in the results section and specify what input search parameters were used to find the matched record.
| Match Code | Match Type |
|---|---|
| L | LastName |
| F | FirstName |
| LF |
LF0 - First and Last name match LF1 - First and Last name appear swapped LF2 - Full name matches |
| E | EmailAddr |
| DOM | Email Domain |
| H | Social Handle |
| P | Phone |
| AHN | Address house number |
| AS | Address street |
| C | City |
| S | State |
| Z | Zip |
| ACSZ | If A and (C,S or Z) appear this flag will be set. |
| CS | City and State match |
| D | DOB or age |
| INDIV | Individual match. Individuals can be matched in many ways but all include some matching ocmponent to a first/last name or specific individual identifier such as Email. If you do not provide these minimums query parameters, an INDIV code will not appear. |
| HHLD | Household match. For this code to occur, a household must have been input (address/city/state) and name |
Zip+4 Demographic Append Overview
Append LifeData ® (extensive demographic data) to any zip+4 in the United States. With over 44 million zip+4 codes in the US, each zip+4 represents as few as 8 people. This fine level of granularity, covering the entire US, provides valuable insight into any US location.
Request URL
https://api.datamarket.azure.com/datafinder/zip4/v1/
Parameters
Search Parameters
Any parameter that begins with a "d_" is a search parameter. We will attempt to map these to a Zip+4. Some search parameters cannot be used by themselves, such as d_last. If a search parameter requires another, it will be noted in the table below.
| Name | Description |
|---|---|
| d_zip4 |
A 4 digit zip+4 in the USA. Example:d_zip4=4088 |
| d_zip |
A 5 digit zip code in the USA. Requires: d_fulladdr Example:d_zip=87402 |
Output Fields
For a list of fields returned, please see the "Details" tab on the Azure Marketplace page.
Zip Demographic Append Overview
Datafinder's LifeData ® provides extensive demographic information for nearly any 5 digit US zip code. Gain valuable insight into more than 900 demographic fields including results such as: AvgHouseholdSize, AverageHouseholdIncome, PctgOwnerOccupiedHouseholds, Own/Rent, and hundreds more.
Request URL
https://api.datamarket.azure.com/datafinder/zip5/v1/
Parameters
Search Parameters
Any parameter that begins with a "d_" is a search parameter. We will attempt to map these to a Zip+4. Some search parameters cannot be used by themselves, such as d_last. If a search parameter requires another, it will be noted in the table below.
| Name | Description |
|---|---|
| d_zip |
A 5 digit zip code in the USA. Requires: d_fulladdr Example:d_zip=87402 |
Output Fields
For a list of fields returned, please see the "Details" tab on the Azure Marketplace page.
