Datazapp API Documentation

Reverse IP Append API

Submit IP addresses to return IP location, ISP, organization, proxy indicators, and available identity/contact data for website visitor identification and remarketing workflows.

Version: 1.0.0
Method: POST
Format: JSON

Get Started

Datazapp’s Reverse IP Append API helps recover website visitor information so you can remarket through direct mail, email, custom audiences, and phone outreach when matched data is available.

The API enforces a maximum limit of 10 records per request. Use AppendType to choose the level of IP append output.

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 IP Append API Request

Submit your API key, append module, append type, and IP address input in the request body.

JSON Request Body
{
  "ApiKey": "Put your api key here",
  "AppendModule": "ReverseIPAppend",
  "AppendType": "3",
  "Data": [
    {
      "IP": "xx.xx.xx.xx"
    }
  ]
}

Request Parameters

Parameter Required Type Description
ApiKeyYesStringYour assigned Datazapp API key.
AppendModuleYesStringUse ReverseIPAppend.
AppendTypeYesInteger / StringDetermines which Reverse IP Append output type should be used.
IsMaximizedAppendNoBooleantrue returns matches from the full list. false returns matches from the past 10 months.
DataYesArrayContains submitted IP records to process.
IPYesStringIP address used for matching.

AppendType Values

1 — Advanced IP Append Returns advanced IP append results when available.
2 — Basic + Advanced Returns both basic and advanced IP append results.
3 — Basic IP Append Returns basic IP location and provider data.
4 — Advanced with Phone Advanced IP append where cell or phone data is available.
5 — Basic + Advanced with Phone Basic and advanced IP append where cell or phone data is available.

API Response

A successful response includes IP intelligence fields, available identity/contact data, order amount, count, and processing time.

JSON Response
{
  "header": {
    "Status": 0,
    "Message": null
  },
  "ResponseDetail": {
    "App": 0,
    "Token": "xxxxx",
    "Data": [
      {
        "FirstName": null,
        "LastName": null,
        "Address": null,
        "Address2": null,
        "Email": null,
        "Cell": null,
        "Cell_DNC": null,
        "Phone": null,
        "Phone_DNC": null,
        "State": null,
        "City": null,
        "Country": null,
        "ZipCode": null,
        "IP": "xxx.xxx.xxx.xxx",
        "IPCountry": "xx",
        "IPState": "C****l***a",
        "IPCity": "p*** a***o",
        "IPZipCode": "xxxxxx",
        "IPLatitude": "xx.xxxx",
        "IPLongitude": "xx.xxxx",
        "ISP": "V********** **m*********n",
        "Organization": "xxxxxxxx",
        "IPType": "",
        "IsProxy": "",
        "LastSeenDate": null,
        "AddressStatus": null,
        "AddressType": null,
        "ResidentialAddressFlag": null,
        "Confidence": null
      }
    ],
    "OrderAmount": "$0",
    "Count": 1,
    "Message": null,
    "ProcessedTime": "xxx 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 reverse IP append result records.
FirstNameStringFirst name associated with the matched record, when available.
LastNameStringLast name associated with the matched record, when available.
AddressStringPostal address associated with the matched record, when available.
Address2StringSecondary postal address, when available.
EmailStringEmail address associated with the matched record, when available.
CellStringCell phone associated with the matched record, when available.
Cell_DNCStringCell phone DNC indicator.
PhoneStringLandline phone associated with the matched record, when available.
Phone_DNCStringLandline phone DNC indicator.
StateStringState associated with the matched postal record.
CityStringCity associated with the matched postal record.
CountryStringCountry associated with the matched postal record.
ZipCodeStringZIP code associated with the matched postal record.
IPStringSubmitted IP address.
IPCountryStringCountry associated with the IP address.
IPStateStringState associated with the IP address.
IPCityStringCity associated with the IP address.
IPZipCodeStringZIP code associated with the IP address.
IPLatitudeStringLatitude associated with the IP address.
IPLongitudeStringLongitude associated with the IP address.
ISPStringInternet service provider associated with the IP address.
OrganizationStringOrganization associated with the ISP or IP address.
IPTypeStringIP type, such as IPv4.
IsProxyStringProxy indicator, when available.
LastSeenDateStringLast seen date associated with the IP match, when available.
AddressStatusStringAddress status associated with the returned record.
AddressTypeStringAddress type associated with the returned record.
ResidentialAddressFlagStringResidential address flag associated with the returned record.
ConfidenceStringConfidence value associated with the returned match.
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