Reverse Address API - Documentation

curl --request GET \
  --url "https://api.trestleiq.com/3.1/location?address.street_line_1=100%20Main%20St&address.city=Seattle&address.state_code=WA&address.postal_code=98101" \
  --header "x-api-key: YOUR_API_KEY"

{
  "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
  "is_valid": true,
  "street_line_1": "100 Syrws St",
  "street_line_2": "Ste 1",
  "city": "Lynden",
  "postal_code": "98264",
  "zip4": "98264-9999",
  "state_code": "WA",
  "country_code": "US",
  "lat_long": {
    "latitude": 0,
    "longitude": 0,
    "accuracy": "Neighborhood"
  },
  "is_active": true,
  "is_commercial": true,
  "delivery_point": "SingleUnit",
  "current_residents": [
    {
      "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
      "name": "Waidong L Syrws",
      "firstname": "Waidong",
      "middlename": "L",
      "lastname": "Syrws",
      "alternate_names": [
        "Sryws W L"
      ],
      "age_range": "25-29",
      "gender": null,
      "type": "Person",
      "industry": null,
      "link_to_address_start_date": "2023-01-02",
      "historical_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "street_line_1": "10 Main St",
          "street_line_2": "Ste 1",
          "city": "Lynden",
          "postal_code": "98264",
          "zip4": "98264-9999",
          "state_code": "WA",
          "country_code": "US",
          "lat_long": {
            "latitude": 0,
            "longitude": 0,
            "accuracy": "Neighborhood"
          },
          "is_active": true,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05",
          "link_to_person_end_date": null
        }
      ],
      "associated_people": [
        {
          "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
          "name": "Waidong L Syrws",
          "firstname": "Waidong",
          "middlename": "L",
          "lastname": "Syrws",
          "relation": "Household"
        }
      ]
    }
  ],
  "error": {
    "name": "InternalError",
    "message": "Could not retrieve entire response"
  },
  "warnings": [
    "Missing Input"
  ]
}

curl --request GET \
  --url "https://api.trestleiq.com/3.1/location?address.street_line_1=100%20Main%20St&address.city=Seattle&address.state_code=WA&address.postal_code=98101" \
  --header "x-api-key: YOUR_API_KEY"

{
  "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
  "is_valid": true,
  "street_line_1": "100 Syrws St",
  "street_line_2": "Ste 1",
  "city": "Lynden",
  "postal_code": "98264",
  "zip4": "98264-9999",
  "state_code": "WA",
  "country_code": "US",
  "lat_long": {
    "latitude": 0,
    "longitude": 0,
    "accuracy": "Neighborhood"
  },
  "is_active": true,
  "is_commercial": true,
  "delivery_point": "SingleUnit",
  "current_residents": [
    {
      "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
      "name": "Waidong L Syrws",
      "firstname": "Waidong",
      "middlename": "L",
      "lastname": "Syrws",
      "alternate_names": [
        "Sryws W L"
      ],
      "age_range": "25-29",
      "gender": null,
      "type": "Person",
      "industry": null,
      "link_to_address_start_date": "2023-01-02",
      "historical_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "street_line_1": "10 Main St",
          "street_line_2": "Ste 1",
          "city": "Lynden",
          "postal_code": "98264",
          "zip4": "98264-9999",
          "state_code": "WA",
          "country_code": "US",
          "lat_long": {
            "latitude": 0,
            "longitude": 0,
            "accuracy": "Neighborhood"
          },
          "is_active": true,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05",
          "link_to_person_end_date": null
        }
      ],
      "associated_people": [
        {
          "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
          "name": "Waidong L Syrws",
          "firstname": "Waidong",
          "middlename": "L",
          "lastname": "Syrws",
          "relation": "Household"
        }
      ]
    }
  ],
  "error": {
    "name": "InternalError",
    "message": "Could not retrieve entire response"
  },
  "warnings": [
    "Missing Input"
  ]
}

curl --request GET \
  --url "https://api.trestleiq.com/3.1/location?address.street_line_1=100%20Main%20St&address.city=Seattle&address.state_code=WA&address.postal_code=98101" \
  --header "x-api-key: YOUR_API_KEY"

{
  "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
  "is_valid": true,
  "street_line_1": "100 Syrws St",
  "street_line_2": "Ste 1",
  "city": "Lynden",
  "postal_code": "98264",
  "zip4": "98264-9999",
  "state_code": "WA",
  "country_code": "US",
  "lat_long": {
    "latitude": 0,
    "longitude": 0,
    "accuracy": "Neighborhood"
  },
  "is_active": true,
  "is_commercial": true,
  "delivery_point": "SingleUnit",
  "current_residents": [
    {
      "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
      "name": "Waidong L Syrws",
      "firstname": "Waidong",
      "middlename": "L",
      "lastname": "Syrws",
      "alternate_names": [
        "Sryws W L"
      ],
      "age_range": "25-29",
      "gender": null,
      "type": "Person",
      "industry": null,
      "link_to_address_start_date": "2023-01-02",
      "historical_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "street_line_1": "10 Main St",
          "street_line_2": "Ste 1",
          "city": "Lynden",
          "postal_code": "98264",
          "zip4": "98264-9999",
          "state_code": "WA",
          "country_code": "US",
          "lat_long": {
            "latitude": 0,
            "longitude": 0,
            "accuracy": "Neighborhood"
          },
          "is_active": true,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05",
          "link_to_person_end_date": null
        }
      ],
      "associated_people": [
        {
          "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
          "name": "Waidong L Syrws",
          "firstname": "Waidong",
          "middlename": "L",
          "lastname": "Syrws",
          "relation": "Household"
        }
      ]
    }
  ],
  "error": {
    "name": "InternalError",
    "message": "Could not retrieve entire response"
  },
  "warnings": [
    "Missing Input"
  ]
}

curl --request GET \
  --url "https://api.trestleiq.com/3.1/location?address.street_line_1=100%20Main%20St&address.city=Seattle&address.state_code=WA&address.postal_code=98101" \
  --header "x-api-key: YOUR_API_KEY"

{
  "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
  "is_valid": true,
  "street_line_1": "100 Syrws St",
  "street_line_2": "Ste 1",
  "city": "Lynden",
  "postal_code": "98264",
  "zip4": "98264-9999",
  "state_code": "WA",
  "country_code": "US",
  "lat_long": {
    "latitude": 0,
    "longitude": 0,
    "accuracy": "Neighborhood"
  },
  "is_active": true,
  "is_commercial": true,
  "delivery_point": "SingleUnit",
  "current_residents": [
    {
      "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
      "name": "Waidong L Syrws",
      "firstname": "Waidong",
      "middlename": "L",
      "lastname": "Syrws",
      "alternate_names": [
        "Sryws W L"
      ],
      "age_range": "25-29",
      "gender": null,
      "type": "Person",
      "industry": null,
      "link_to_address_start_date": "2023-01-02",
      "historical_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "street_line_1": "10 Main St",
          "street_line_2": "Ste 1",
          "city": "Lynden",
          "postal_code": "98264",
          "zip4": "98264-9999",
          "state_code": "WA",
          "country_code": "US",
          "lat_long": {
            "latitude": 0,
            "longitude": 0,
            "accuracy": "Neighborhood"
          },
          "is_active": true,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05",
          "link_to_person_end_date": null
        }
      ],
      "associated_people": [
        {
          "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
          "name": "Waidong L Syrws",
          "firstname": "Waidong",
          "middlename": "L",
          "lastname": "Syrws",
          "relation": "Household"
        }
      ]
    }
  ],
  "error": {
    "name": "InternalError",
    "message": "Could not retrieve entire response"
  },
  "warnings": [
    "Missing Input"
  ]
}

Reverse Address 3.1

GET https://api.trestleiq.com/3.1/location?api_key=[insert_key]&city=[insert_city]&postal_code=[insert_postal_code]&state_code=[insert_state_code]&street_line_1=[insert_street_line_1]

Query Parameters

street_line_1

string

The first line of the street part in the structured address. Cannot be longer than 1000 characters. Example: street_line_1=100 Syrws St

street_line_2

string

The second line of the street part in the structured address. Cannot be longer than 1000 characters. Example: street_line_2=Ste 1

city

string

The name of the city in the structured address. Cannot be longer than 500 characters. Example: city=Seattle

state_code

string

The state code of the structured address. Cannot be longer than 100 characters. Example: state_code=WA

postal_code

string

The postal code of the structured address. Cannot be longer than 100 characters. Example: postal_code=98101

country_code

string (ISO-3166-2)

The ISO-3166 alpha-2 country code of the address. Cannot be longer than 100 characters. Example: country_code=US

Headers

x-api-key

string

required

Your API key for authentication. Example: {{ apiKey }}

Response

string or null <Location.<uuid>>

The persistent ID of the address.

is_valid

boolean or null

True if the address is valid.

street_line_1

string or null

The first line of the street part in the structured address.

street_line_2

string or null

The second line of the street part in the structured address.

city

string or null

The name of the city in the structured address.

postal_code

string or null

The postal code of the structured address.

state_code

string or null

The state code of the structured address.

zip4

string or null ^\d+-\d{4}$

The ZIP+4 code of the structured address (USA).

country_code

string or null (ISO-3166-2)

The ISO-3166 alpha-2 country code of the address.

lat_long

object or null

The coordinates of the geographical location of the address.

Show lat_long object

latitude

number or null <double>

The latitude coordinate of the location.

longitude

number or null <double>

The longitude coordinate of the location.

accuracy

string or null

The accuracy of the geographical location. Enum: Country State City PostalCode Neighborhood Street RoofTop

is_active

boolean or null

True if the address is currently receiving mail.

is_commercial

boolean or null

True if the address is a business address.

delivery_point

string or null (DeliveryPoint)

The type of the delivery point of the address. Enum: SingleUnit MultiUnit POBox PartialAddress

current_residents

object[]

The list of current person and business residents at the address.

Show owner object

string or null <Person.<uuid>>

The persistent ID of the address.

name

string or null

The full name of the person.

firstname

string or null (FirstName)

The first name of the person.

middlename

string or null (MiddleName)

The middle name (or middle initial) of the person.

lastname

string or null (LastName)

The last name of the person.

alternate_names

string[]

Alternate names of the person associated with the phone.

age_range

string or null (AgeRange)

The age of the person in a 5-year range.

gender

string or null (Gender)

The gender of the person.

type

string

The type of the legal entity.

Person: The legal entity is a person.
Business: The legal entity is a company.

Enum: Person Business

link_to_phone_start_date

string or null

The date when the person was first linked to the phone number.

industry

string[] or null

The industry classification of the business associated to the phone.

historical_addresses

object[]

A list of historical addresses associated with the current resident of the input address.

Show address object

string or null <Location.<uuid>>

The persistent ID of the address.

location_type

string or null

The type of the location. Enum: Country State City PostalCode ZipPlus4 C Address

street_line_1

string or null

The first line of the street part in the structured address.

street_line_2

string or null

The second line of the street part in the structured address.

city

string or null

The city associated with the address.

postal_code

string or null

The postal code of the structured address.

zip4

string or null ^\d+-\d{4}$

The ZIP+4 code of the structured address (USA).

state_code

string or null

The state code of the structured address.

country_code

string or null (ISO-3166-2)

The ISO-3166 alpha-2 country code of the phone number. See:ISO-3166.

lat_long

object or null

The coordinates of the geographical location of the address.

Show lat_long object

latitude

number or null <double>

The latitude coordinate of the location.

longitude

number or null <double>

The longitude coordinate of the location.

accuracy

string or null

The accuracy of the geographical location. Enum: Country State City PostalCode Neighborhood Street RoofTop

is_active

boolean or null

True if the address is currently receiving mail.

delivery_point

string or null (DeliveryPoint)

The type of the delivery point of the address. Enum: SingleUnit MultiUnit POBox PartialAddress

link_to_person_start_date

string or null (LinkToPersonStartDate)

The date when the address was first linked to the person.

link_to_person_end_date

string or null

The date when the address was last linked to the person.

associated_people

object[]

A list of people associated to the current home owner.

Show people object

string or null <Person.<uuid>>

The persistent ID of the person.

name

string or null

The full name of the associated person.

firstname

string or null

The first name of the associated person.

middlename

string or null

The middle name of the associated person.

lastname

string or null

The last name of the associated person.

relation

string or null

The relationship between the address owner and the associated person.

error

object(PartialError)

Error details in case of an error.

Show error object

name

string

Incomplete response due to external timeouts. value: “InternalError”

message

string

The error message. value: “Could not retrieve entire response”

warnings

string[]

Warnings returned as part of the response, if applicable.

Enum: Invalid Address Missing Input Invalid house/building number Missing unit/apt/suite number Invalid unit/apt/suite number

Error Responses

400 Bad Request

The server cannot process the request due to client-side errors.Check for: Syntax errors in the request script, malformed JSON, or invalid parameters.

403 Forbidden

The request is understood, but the server is refusing to fulfill it.

Invalid API Key: The key is incorrect or deactivated. Check for: Trailing spaces, syntax errors, or incorrect character counts.
API Key Missing: The request header did not include an API key.
API Key Disabled (Portal Issue): The key is inactive. Check for: Insufficient funds in your self-serve wallet or if a Trestle Admin manually deactivated your API key.
API Key does not have Product Access (Portal Issue): The API key is active, but it is not enabled for this product or API version. Check for: Incorrect endpoint, incorrect API version, or missing product access on the key.
API Key Expired: The key has reached its end-of-life (primarily affects Trial users).

429 Too Many Requests

You have sent too many requests in a given amount of time.

Rate Limit Exceeded: You have surpassed the queries-per-second (QPS) threshold for your tier.
Quota Exceeded (Portal Issue): You have reached the total volume allowed for your current billing cycle. Upgrade your plan in the portal to resume service.

500 Internal Server Error

An unexpected error occurred on the server side. Please contact support if this persists.

Phone Validation API Real Contact API 2.0 (Latest)

​Reverse Address 3.1

​Query Parameters

​Headers

​Response

​Error Responses

​400 Bad Request

​403 Forbidden

​429 Too Many Requests

​500 Internal Server Error

Reverse Address 3.1

Query Parameters

Headers

Response

Error Responses

400 Bad Request

403 Forbidden

429 Too Many Requests

500 Internal Server Error