Name Append API

Get Started

The Name Append API takes postal data input — including address, city, state, and ZIP code — and returns matched first and last name values when available.

To use this API, you’ll need an active API key. Contact Datazapp support or your account representative to request API access.

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>

Name Append API Request

Submit your API key, append module, and postal address records in the request body.

JSON Request Body

{
  "ApiKey": "Your API Key",
  "AppendModule": "NameAppendAPI",
  "Data": [
    {
      "Address": "123 Main St",
      "City": "Philadelphia",
      "State": "PA",
      "Zip": "19107"
    }
  ]
}

Request Parameters

Parameter	Required	Type	Description
`ApiKey`	Yes	String	Your assigned Datazapp API key.
`AppendModule`	Yes	String	Use `NameAppendAPI`.
`Data`	Yes	Array	Contains the postal records to process.
`Address`	Yes	String	Street address line.
`City`	Yes	String	City name.
`State`	Yes	String	Two-letter state abbreviation.
`Zip`	Yes	String	5-digit ZIP code. ZIP+4 may also be accepted.

API Response

A successful response includes a header, system-generated token, returned name data, matched count, order amount, and processing time.

JSON 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
}

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 append result records.
`Matched`	Boolean / String	Indicates whether the submitted record matched.
`AddressType`	String	Returned address type value.
`Tag`	String	Optional tag value returned with the record.
`FirstName`	String	Returned first name.
`LastName`	String	Returned last name.
`Address`	String	Street address associated with the returned record.
`City`	String	City associated with the returned record.
`State`	String	State associated with the returned record.
`Zip`	String	ZIP code associated with the returned record.
`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.