Get started
API Endpoint
"<datazapp api endpoint URL>"
Our DOB & Age Append API allows you to quickly and accurately match customer data with Email, includes first, last, address, city, state, and zip. To use our phone append api, you need a data set that includes first, last, address, city, state, and zip. And responses DOB and/or Age are returned in JSON format.
To use this API, you need an API key. Please contact us at [email protected] to get your API key.
DOB & Age Append API Request
Query Parameters
Request{ "ApiKey": "Your Key", "AppendModule": "DOBAgeAppend", "AppendType": 2, "Data": [ { "Email": "[email protected]" }, { "Email": "[email protected]" } ] } Or { "ApiKey": "", "AppendModule": "DOBAgeAppendAPI", "AppendType": 1, "Data": [ { "Address": "140***** JU*****N RD", "City": "PE*****G", "FirstName": "S***H", "LastName": "R***P", "Zip": "4***1" } ]
| Parameter | Type | Required | Description | |
|---|---|---|---|---|
| Parameter | Occurs | Description | Type | |
| APIKey | required | Issued by sales support or Datazapp Admin | String | |
| AppendModule | required | PhoneAppendAPI | String | |
| Append Type | required | Valid values 1,2 1- DOB Append 2- Age Append |
Integer | |
| FirstName | required | First name (first name of person in household) | String | Use this combination for append based on individual name & address |
| LastName | required | Last name (last name of person in household) | String | |
| Address | required | Valid United States postal address. | String | |
| City | required | Valid United States City name. | String | |
| State | required | Valid United States State name. | String | |
| ZIP | required | Zip code associated. Zip or Zip+4 is accepted. | String | |
| required | Email id of the individual. | String | This will append based on email id. |
Response
Query Parameters
Response JSON Example: (Age) { "header": { "Status": 0, "Message": null }, "ResponseDetail": { "App": 0, "Token": "AxxxxQ", "Data": [ { "Matched": true, "Email": "[email protected]", "DOB": null, "Age": "xx", "Tag": null, "FirstName": "", "LastName": "", "Address": "", "City": "", "State": "", "Zip": "" }, { "Matched": true, "Email": "[email protected]", "DOB": null, "Age": "xx", "Tag": null, "FirstName": "xxxxxxxx", "LastName": "xxxxxxxx", "Address": "xxxxxxxxxxxxxxxxxxxxxxxx", "City": "xxxxx", "State": "xxxx", "Zip": "xxxxx" } ], "OrderAmount": "$x.xx", "Count": 2, "Message": null, "ProcessedTime": "xxx milliseconds" }, "Status": true, "Message": null } OR Response JSON Example: (DOB) { "header": { "Status": 0, "Message": null }, "ResponseDetail": { "App": 0, "Token": "E****R", "Data": [ { "Matched": true, "Email": "", "DOB": "YES", "Age": null, "Tag": null, "FirstName": "S****H", "LastName": "R****", "Address": "14*** C**L J****N R*", "City": "PE*******G", "State": "", "Zip": "4*****1" } ], "OrderAmount": "$0", "Count": 1, "Message": null, "ProcessedTime": "110 milliseconds" }, "Status": true, "Message": null }
| Field | Type | Description |
|---|---|---|
| Following Parameters Should be send in Header: | ||
| Status | Integer | Indicate header status |
| Message | String | Indicate type of error |
| Following Parameters Should be send in ResponseDetails: | ||
| App | ||
| Token | String | System generated reference. |
| Following parameters should be sent in Data Object in Array format: | ||
| Matched | String | True=if matched , False =if not matched data |
| String | Phone(landline) number of person in household | |
| DOB | String | Date Of Birth of person in household |
| Age | String | Age of person in household |
| Tag | String | |
| FirstName | String | First name (name of person in household) |
| LastName | String | Last name (name of person in household) |
| Address | String | United states postal address. |
| City | String | City of Individual from United States. |
| Zip | String | Zip code associated. Zip or Zip+4 is accepted |
| OrderAmount | String | Amount of count |
| Count | String | Number of count |
| Message | String | Null |
| ProcessedTime | String | Processing time |
| Status | String | True,False |
| Message | String | Null |
Errors
The API uses the following error codes:
| Error Code | Meaning |
|---|---|
| Module does not exist. | The specified module does not exist or Invalid AppendModule Name. |
| User not found. | Invalid API Key or The user associated with the API key was not found |
| Getting 401 Error. | The user does not have access to this API |
| Append Request not found | Invalid Token: The specified append request could not be found |
| Improper JSON Data. Please check. | The JSON data in the request does not match the expected format. |
| It seems like API has an issue. Please contact Support. | There is an issue with the API. Contact the [email protected] |
