Get started

    API Endpoint

         "<datazapp api endpoint URL>"

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

Request                    
{
    "ApiKey": "Your API Key",
    "AppendModule": "NameAppendAPI",
    "Data": [
        {
            "Address": "8x x AxxxxE xD",
            "City": "PxxxxxxxA",
            "Zip": "1xxx8"
        }
    ]
}

Parameter	Type	Required	Description
APIKEY	String	(required)	Issued by sales support or Datazapp Admin
Append Module	String	(required)	NameAppendAPI
Address	String	(required)	Use this combination for append based on individual name & address
City	String	(required)
State	String	(required)
ZIP	String	(required)

Response

Query Parameters

                    

Response

{
    "header": {
        "Status": 0,
        "Message": null
    },
    "ResponseDetail": {
        "App": 0,
        "Token": "LxxxxT",
        "Data": [
            {
                "Matched": true,
                "AddressType": "",
                "Tag": null,
                "FirstName": "WxxxxxM",
                "LastName": "KxxxxxS",
                "Address": "8xx AxxxxE xD",
                "City": "PxxxxxxxA",
                "State": "",
                "Zip": "1xxx8"
            }
        ],
        "OrderAmount": "$0.02",
        "Count": 1,
        "Message": null,
        "ProcessedTime": "234 milliseconds"
    },
    "Status": true,
    "Message": null
}

Field	Type	Description
Following Parameters returned in Header:
Status	Integer	Indicate header status
Message	String	Indicate type of error
Following Parameters returned in ResponseDetails:
Token	String	System generated reference.
Below Parameters will be returned as Data Object in Array Format:
Matched	String	True=if matched, False=if not matched data
FirstName	String	First name (name of person in household)
LastName	String	Last name (name of person in household)
Address	String	Street Address.
City	String	City name.
Zip	String	Zip code associated. Zip or Zip+4 is accepted.
OrderAmount	String	Amount of count
Count	String	Number of count
ProcessedTime	String	Processing time
Status	String	True
Message	String	Error Message in case of any error.

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]