The Data Group

Vehicle Append Tutorial


Vehicle Append is a real-time solution for retrieving a list of all of the vehicles a given person is believed to own.

Vehicle Append URI

The Vehicle Append URI accepts a person’s name and address and returns the list of vehicles that person currently owns.

Required Information

The Vehicle Append URI requires you to have an Authorization Token. If you have not retrieved an Authorization Token yet, follow the Authorization Tutorial before continuing.

The Vehicle Append URI, like all of the solution URIs, also requires you to have an API Key. If you do not know your API Key, contact support to retrieve it. The API Key should be provided in the request header with the header attribute: x-api-key

The Vehicle Append URI must be used with a POST request, where the request payload contains the person’s name and address to use for appending.

Request URL

The URL for the Vehicle Append URI is:{version}/sync/append/vehicle, where {version} is the API Version you wish to use.

Request Headers
Header AttributeHeader Value
x-api-key{your api key}
AuthorizationToken{your authorization token}
Request Payload

The request payload for the Vehicle Append URI must contain the first_name, last_name and the address_1 attributes. . It must also contain either the zipcode attribute or both the city and state attributes.

{ “first_name”: “John”, "last_name”: “Smith”, “address_1”: “425 S. Avalon Park BLVD”, “zipcode”: “32828” }
cURL Example

To query the Vehicle Append URI, you can use one of the provided SDKs, a REST Client, or a simple cURL command. Below is an example of the cURL command for the example input information.

curl -X POST -H "AuthorizationToken: {your token here}" -H "x-api-key: {your key here}" -H "Content-Type: application/json" -d '{ “first_name”: “John”, "last_name”: “Smith”, “address_1”: “425 S. Avalon Park BLVD”, “zipcode”: “32828” }' ""
Response Payload

The response payload for the Vehicle Append URI will contain the person and their address, as well as a list of vehicles the person currently owns and has owned in the past.

{ address : { zipcode: “32828”, unit_number: “425”, city: “ORLANDO”, post_direction: “N”, street_number: “1234”, pre_driection: “S”, street_type: “BLVD”, state: “FL”, unit_type: “DWELLING”, street_name: “AVALON PARK SOUTH” }, last_name: