Get started
API Endpoint: "Get this URL from your DZ account manager"
This API takes postal data input (Address, City, & Zip Code) and returns First & Last Name values.
To use this API, you need an API key. Please contact us at [email protected] to get your API key.
Name Append API Request
Query Parameters
{
"ApiKey": "Your API Key",
"AppendModule": "NameAppendAPI",
"Data": [
{
"Address": "123 Main St",
"City": "Philadelphia",
"State": "PA",
"Zip": "19107"
}
]
}
| Parameter | Type | Required | Description |
|---|---|---|---|
| APIKEY | String | (required) | Issued by sales support or Datazapp Admin |
| AppendModule | String | (required) | NameAppendAPI |
| Address | String | (required) | Street Address lines |
| City | String | (required) | City identity |
| State | String | (required) | Two letter state code |
| ZIP | String | (required) | 5-digit Zip or Zip+4 matching |
Response
{
"header": {
"Status": 0,
"Message": null
},
"ResponseDetail": {
"App": 0,
"Token": "L23K91T",
"Data": [
{
"Matched": true,
"AddressType": "S",
"Tag": null,
"FirstName": "John",
"LastName": "Smith",
"Address": "123 Main St",
"City": "Philadelphia",
"State": "PA",
"Zip": "19107"
}
],
"OrderAmount": "$0.02",
"Count": 1,
"Message": null,
"ProcessedTime": "234 milliseconds"
},
"Status": true,
"Message": 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. |