Get started

    API Endpoint

         "<datazapp api endpoint URL>"

Append phone and cell numbers to your data with our Phone Append API. Choose between all phones or DNC scrubbed phones based on your preference.

To use this API, you need an API key. Please contact us at [email protected] to get your API key.

Phone Append API Request

Query Parameters

Request                    
{
    "ApiKey": "Your API key",
    "AppendModule": "PhoneAppendAPI",
    "AppendType": 3,
    "DncFlag": "false",
    "Data": [
        {
            "FirstName": "John",
            "LastName": "Doe",
            "Address": "123 Main St",
            "City": "Anytown",
            "Zip": "12345"
        }
    ]
}

Parameter	Type	Required	Description
APIKey	Required	String	Your API Key
AppendModule	Required	String	Specifies the module, e.g., PhoneAppendAPI.
AppendType	Required	Integer	Type of phone data requested. Valid values 1,2,3,5 1- Cellphone 2- Landline 3- Both (Single column. Cell priority & landline) 5- Both (Separate Columns, Landline & Cell Different Columns)
DncFlag	Required	String	Filters Do Not Call numbers. Valid values 1 or “true” (Returns Phones not on Do Not Call-DNC) 0 or “false” (Returns all available Phones on DNC & not on DNC)
Data	Required	Array	Contains customer data fields.

Response

Query Parameters

                    

Response

{
 "header": {
 "Status": 200,
 "Message": "Success"
 },
 "ResponseDetail": {
        "App": 0,
        "Token": "X****C",
        "Data": [
            {
                "PhoneType": "C",
                "Matched": true,
                "Phone": "4******5",
                "DoNotCall": "Y",
                "Tag": "",
                "FirstName": "John",
                "LastName": "Doe",
                "Address": "1******* **R",
                "City": "Anytown",
                "Zip": "12345",
                "AlterFirstName": "",
                "AlterLastName": "",
                "AlterAddress": "",
                "AlterCity": "",
                "AlterZip": ""
            },
],
 "OrderAmount": "$0.00",
 "Count": 1,
 "ProcessedTime": "221 milliseconds"
 }
}

Field	Type	Description
Status	Integer	Indicate header status
Message	String	Indicate type of error
ResponseDetails	App
Token	String	System generated reference
Data (Array)	Array
Matched	String	Whether there is a match
PhoneType	String	Types of phones: C = Cell Phone, H = Household Phone
Phone	String	Phone number of person in household
DoNotCall	String	Whether phone number is in Do Not Call list (Yes/No)
Cell	String	Cell phone number of person in household
CellDoNotCall	String	Whether cell phone number is in Do Not Call list (Yes/No)
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
AlterFirstName	String	2nd First name
AlterLastName	String	2nd Last name
AlterAddress	String	2nd Address
AlterCity	String	2nd Address City
AlterZip	String	2nd Address ZIP
OrderAmount	String	Amount for returned matches
Count	String	Quantity Matched
Message	String
ProcessedTime	String	Processing time
Status	String	True or False
Message	String

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]