Datazapp API Documentation

DOB & Age Append API

Append date of birth or age data to customer records using Datazapp’s DOB & Age Append API. Submit either email-based records or name and address records to receive matched DOB and/or age values.

Version: 1.0.0
Method: POST
Format: JSON

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.

Records may be submitted using either an email address or a name and postal address combination. To use this API, you’ll need an active API key.

API Endpoint

Replace the placeholder below with your assigned Datazapp API endpoint URL.

Endpoint - you'll get this from your account manager
<datazapp api endpoint URL>

DOB & Age Append API Request

Submit your API key, append module, append type, and customer records in the request body.

JSON Request Body - Email Input
{
  "ApiKey": "Your Key",
  "AppendModule": "DOBAgeAppend",
  "AppendType": 2,
  "Data": [
    {
      "Email": "[email protected]"
    },
    {
      "Email": "[email protected]"
    }
  ]
}
JSON Request Body - Name & Address Input
{
  "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
ApiKeyYesStringYour assigned Datazapp API key.
AppendModuleYesStringUse DOBAgeAppend or DOBAgeAppendAPI.
AppendTypeYesIntegerDetermines whether DOB or age data should be returned.
DataYesArrayContains the customer records to process.
EmailConditionalStringEmail address used for email-based DOB or age append.
FirstNameConditionalStringFirst name used for name and address matching.
LastNameConditionalStringLast name used for name and address matching.
AddressConditionalStringValid United States postal address.
CityConditionalStringValid United States city name.
StateConditionalStringValid United States state name or abbreviation.
ZipConditionalStringZIP code. ZIP+4 is also accepted.

AppendType Values

1 — DOB Append Returns date of birth data when available.
2 — Age Append Returns age data when available.

API Response

A successful response includes a header, system-generated token, returned data, matched count, order amount, and processing time.

JSON Response - Age
{
  "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
}
JSON Response - DOB
{
  "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.StatusIntegerIndicates header status.
header.MessageStringIndicates error type, when applicable.
ResponseDetail.AppIntegerApplication reference value returned by the system.
ResponseDetail.TokenStringSystem-generated reference token.
ResponseDetail.DataArrayReturned append result records.
MatchedBoolean / StringIndicates whether the submitted record matched.
EmailStringEmail address associated with the returned record.
DOBStringDate of birth result, when returned.
AgeStringAge result, when returned.
TagStringOptional tag value returned with the record.
FirstNameStringFirst name associated with the returned record.
LastNameStringLast name associated with the returned record.
AddressStringPostal address associated with the returned record.
CityStringCity associated with the returned record.
StateStringState associated with the returned record.
ZipStringZIP code associated with the returned record.
OrderAmountStringAmount charged for returned matches.
CountString / IntegerNumber of matched records.
ProcessedTimeStringTotal API processing time.
StatusBoolean / StringIndicates overall request status.
MessageStringNull when successful, or error detail when applicable.

Errors

The API may return one of the following error messages if the request cannot be completed.

Module does not exist.The specified module does not exist or the AppendModule name is invalid.
User not found.The API key is invalid 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.The specified append request could not be found or the token is invalid.
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 may be an issue with the API. Contact Datazapp support for assistance.

Recent Post

Categories