Reverse Phone Append API

Get Started

Datazapp’s Reverse Phone Append API adds names, mailing addresses, city, state, ZIP, and available email addresses to your phone records.

Submit a phone number and receive matched identity and contact data when available. 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>

Reverse Phone Append API Request

Submit your API key, append module, and phone number input in the request body.

JSON Request Body

{
  "ApiKey": "Put your api key here",
  "AppendModule": "ReversePhoneAppendAPI",
  "Data": [
    {
      "Phone": "5551234567"
    }
  ]
}

Request Parameters

Parameter	Required	Type	Description
`ApiKey`	Yes	String	Your assigned Datazapp API key.
`AppendModule`	Yes	String	Use `ReversePhoneAppendAPI`.
`Data`	Yes	Array	Contains the submitted phone records to process.
`Phone`	Yes	String	Phone number used for matching.

API Response

A successful response includes a header, token, returned matched contact records, order amount, count, and processing time.

JSON Response

{
  "header": {
    "Status": 0,
    "Message": null
  },
  "ResponseDetail": {
    "App": 0,
    "Token": "xxxxx",
    "Data": [
      {
        "Matched": true,
        "State": "AL",
        "ZIP": "xxxxx",
        "ZIP4": "xxxx",
        "Address2": "",
        "FirstName2": "CHxxxxxR",
        "LastName2": "COxxxx",
        "CompanyName": "CxxxxxxxxxS",
        "Email": "[email protected]",
        "FirstName": "PxxxNE",
        "LastName": "CxxxxN",
        "Address": "3xxxxxxxxxx",
        "City": "CxxxxxxxN",
        "Zip": null,
        "Phone": "5551234567",
        "PhoneType": "W",
        "DoNotCall": null
      }
    ],
    "OrderAmount": "$0.03",
    "Count": 1,
    "Message": null,
    "ProcessedTime": "xxx 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 reverse phone append result records.
`Matched`	Boolean / String	Indicates whether the submitted phone record matched.
`FirstName`	String	First name associated with the matched phone record.
`LastName`	String	Last name associated with the matched phone record.
`FirstName2`	String	Secondary first name associated with the household, when available.
`LastName2`	String	Secondary last name associated with the household, when available.
`Address`	String	Primary postal address associated with the matched record.
`Address2`	String	Secondary postal address, when available.
`City`	String	City associated with the matched record.
`State`	String	State associated with the matched record.
`Zip`	String	ZIP code associated with the matched record.
`ZIP`	String	ZIP code associated with the matched record.
`ZIP4`	String	ZIP+4 associated with the matched record.
`CompanyName`	String	Business or company name associated with the phone record, when available.
`Email`	String	Email address associated with the matched record, when available.
`Phone`	String	Submitted or matched phone number.
`PhoneType`	String	Phone type, such as wireless or landline.
`DoNotCall`	String	DNC indicator, such as Yes or No, when available.
`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.

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.