Get Started
The DOB & Age Append API allows you to submit customer records and receive matched date of birth and/or age data when available.
API Endpoint
Replace the placeholder below with your assigned Datazapp API endpoint URL.
<datazapp api endpoint URL>
DOB & Age Append API Request
Submit your API key, append module, append type, and customer records in the request body.
{
"ApiKey": "Your Key",
"AppendModule": "DOBAgeAppend",
"AppendType": 2,
"Data": [
{
"Email": "[email protected]"
},
{
"Email": "[email protected]"
}
]
}
{
"ApiKey": "Your Key",
"AppendModule": "DOBAgeAppendAPI",
"AppendType": 1,
"Data": [
{
"FirstName": "John",
"LastName": "Doe",
"Address": "123 Main St",
"City": "Anytown",
"State": "FL",
"Zip": "12345"
}
]
}
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
ApiKey | Yes | String | Your assigned Datazapp API key. |
AppendModule | Yes | String | Use DOBAgeAppend or DOBAgeAppendAPI. |
AppendType | Yes | Integer | Determines whether DOB or age data should be returned. |
Data | Yes | Array | Contains the customer records to process. |
Email | Conditional | String | Email address used for email-based DOB or age append. |
FirstName | Conditional | String | First name used for name and address matching. |
LastName | Conditional | String | Last name used for name and address matching. |
Address | Conditional | String | Valid United States postal address. |
City | Conditional | String | Valid United States city name. |
State | Conditional | String | Valid United States state name or abbreviation. |
Zip | Conditional | String | ZIP code. ZIP+4 is also accepted. |
AppendType Values
API Response
A successful response includes a header, system-generated token, returned data, matched count, order amount, and processing time.
{
"header": {
"Status": 0,
"Message": null
},
"ResponseDetail": {
"App": 0,
"Token": "A****Q",
"Data": [
{
"Matched": true,
"Email": "[email protected]",
"DOB": null,
"Age": "45",
"Tag": null,
"FirstName": "",
"LastName": "",
"Address": "",
"City": "",
"State": "",
"Zip": ""
}
],
"OrderAmount": "$0.00",
"Count": 1,
"Message": null,
"ProcessedTime": "120 milliseconds"
},
"Status": true,
"Message": null
}
{
"header": {
"Status": 0,
"Message": null
},
"ResponseDetail": {
"App": 0,
"Token": "E****R",
"Data": [
{
"Matched": true,
"Email": "",
"DOB": "YES",
"Age": null,
"Tag": null,
"FirstName": "John",
"LastName": "Doe",
"Address": "123 Main St",
"City": "Anytown",
"State": "FL",
"Zip": "12345"
}
],
"OrderAmount": "$0.00",
"Count": 1,
"Message": null,
"ProcessedTime": "110 milliseconds"
},
"Status": true,
"Message": null
}
Response Fields
| Field | Type | Description |
|---|---|---|
header.Status | Integer | Indicates header status. |
header.Message | String | Indicates error type, when applicable. |
ResponseDetail.App | Integer | Application reference value returned by the system. |
ResponseDetail.Token | String | System-generated reference token. |
ResponseDetail.Data | Array | Returned append result records. |
Matched | Boolean / String | Indicates whether the submitted record matched. |
Email | String | Email address associated with the returned record. |
DOB | String | Date of birth result, when returned. |
Age | String | Age result, when returned. |
Tag | String | Optional tag value returned with the record. |
FirstName | String | First name associated with the returned record. |
LastName | String | Last name associated with the returned record. |
Address | String | Postal address associated with the returned record. |
City | String | City associated with the returned record. |
State | String | State associated with the returned record. |
Zip | String | ZIP code associated with the returned record. |
OrderAmount | String | Amount charged for returned matches. |
Count | String / Integer | Number of matched records. |
ProcessedTime | String | Total API processing time. |
Status | Boolean / String | Indicates overall request status. |
Message | String | Null when successful, or error detail when applicable. |
Errors
The API may return one of the following error messages if the request cannot be completed.