Find Person API (Archived)

curl --request GET \
  --url "https://api.trestleiq.com/3.1/person?name=John%20Doe&address.city=Seattle&address.state_code=WA" \
  --header "x-api-key: YOUR_API_KEY"

{
  "count_person": 1,
  "person": [
    {
      "id": "Person.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
      "name": "Waidong L Syrws",
      "firstname": "Waidong",
      "middlename": "L",
      "lastname": "Syrws",
      "alternate_names": [
        "Sryws W L"
      ],
      "age_range": "25-29",
      "gender": null,
      "found_at_address": {
        "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
        "location_type": "Address",
        "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,
        "delivery_point": "SingleUnit",
        "link_to_person_start_date": "2011-10-05"
      },
      "current_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "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,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05"
        }
      ],
      "historical_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "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,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05",
          "link_to_person_end_date": null
        }
      ],
      "phones": [
        {
          "id": "Phone.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
          "phone_number": "2069735100",
          "line_type": "NonFixedVOIP"
        }
      ],
      "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/person?name=John%20Doe&address.city=Seattle&address.state_code=WA" \
  --header "x-api-key: YOUR_API_KEY"

{
  "count_person": 1,
  "person": [
    {
      "id": "Person.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
      "name": "Waidong L Syrws",
      "firstname": "Waidong",
      "middlename": "L",
      "lastname": "Syrws",
      "alternate_names": [
        "Sryws W L"
      ],
      "age_range": "25-29",
      "gender": null,
      "found_at_address": {
        "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
        "location_type": "Address",
        "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,
        "delivery_point": "SingleUnit",
        "link_to_person_start_date": "2011-10-05"
      },
      "current_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "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,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05"
        }
      ],
      "historical_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "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,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05",
          "link_to_person_end_date": null
        }
      ],
      "phones": [
        {
          "id": "Phone.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
          "phone_number": "2069735100",
          "line_type": "NonFixedVOIP"
        }
      ],
      "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/person?name=John%20Doe&address.city=Seattle&address.state_code=WA" \
  --header "x-api-key: YOUR_API_KEY"

{
  "count_person": 1,
  "person": [
    {
      "id": "Person.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
      "name": "Waidong L Syrws",
      "firstname": "Waidong",
      "middlename": "L",
      "lastname": "Syrws",
      "alternate_names": [
        "Sryws W L"
      ],
      "age_range": "25-29",
      "gender": null,
      "found_at_address": {
        "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
        "location_type": "Address",
        "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,
        "delivery_point": "SingleUnit",
        "link_to_person_start_date": "2011-10-05"
      },
      "current_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "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,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05"
        }
      ],
      "historical_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "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,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05",
          "link_to_person_end_date": null
        }
      ],
      "phones": [
        {
          "id": "Phone.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
          "phone_number": "2069735100",
          "line_type": "NonFixedVOIP"
        }
      ],
      "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"
}

GET

3.1

person

curl --request GET \
  --url "https://api.trestleiq.com/3.1/person?name=John%20Doe&address.city=Seattle&address.state_code=WA" \
  --header "x-api-key: YOUR_API_KEY"

{
  "count_person": 1,
  "person": [
    {
      "id": "Person.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
      "name": "Waidong L Syrws",
      "firstname": "Waidong",
      "middlename": "L",
      "lastname": "Syrws",
      "alternate_names": [
        "Sryws W L"
      ],
      "age_range": "25-29",
      "gender": null,
      "found_at_address": {
        "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
        "location_type": "Address",
        "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,
        "delivery_point": "SingleUnit",
        "link_to_person_start_date": "2011-10-05"
      },
      "current_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "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,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05"
        }
      ],
      "historical_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "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,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05",
          "link_to_person_end_date": null
        }
      ],
      "phones": [
        {
          "id": "Phone.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
          "phone_number": "2069735100",
          "line_type": "NonFixedVOIP"
        }
      ],
      "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"
}

Find Person 3.1

GET https://api.trestleiq.com/3.1/person?name=[insert_name]&address.city=[insert_city]&address.state_code=[insert_state_code]

Query Parameters

name

string

required

The name of the person to search. Example: name=John Doe

address.street_line_1

string

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

address.street_line_2

string

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

address.city

string

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

address.postal_code

string

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

address.state_code

string

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

address.country_code

string <ISO-3166-2>

The ISO-3166 alpha-2 country code of the phone number. See: ISO-3166. Example: address.country_code=US

Headers

x-api-key

string

required

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

Response

count_person

integer or null

The number of people returned.

person

object[]

An array of people associate with the address provided.

Show person 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 or null (AlternateNamesPerson)

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.

found_at_address

object or null

Address location of this person.

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: Address Neighborhood Country ZipPlus4 PostalCode City State

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 longer coordinate of the location.

accuracy

string or null

The accuracy of the geographical location. Enum: Neighborhood Country PostalCode Street City State 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.

current_addresses

object[]

An array of current address locations associated with this person.

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: Address Neighborhood Country ZipPlus4 PostalCode City State

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 longer coordinate of the location.

accuracy

string or null

The accuracy of the geographical location. Enum: Neighborhood Country PostalCode Street City State 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.

error

object(PartialError)

Error details in case of an error.

Show error object

name

string

TIncomplete 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. Possible values include: Invalid Input, International number. Not authorized, or Missing Input.

Error Responses

400

Invalid Parameters Error: Parameter called incorrectly.
Input Field Error: Incorrect parameter information, such as non-existent area code on a phone number.
Input Error: No parameters given.
Internal Error: If there is an internal error while performing the checks

401

Bad Request: If ’;’ used as parameter separator in request. Non-UTF-8-encoded request.
Not Authorized: No api_key parameter in the request.

403

Auth Error: API Key is not authorized for that request or expired.
Quota Exceeded Error: API Key has exceeded its quota.

429 Too Many Requests

API Key has exceeded its rate limit.

500 Internal Server Error

An unexpected error occurred on the server.

Reverse Address API (Archived)Real Contact API (Archived)

Get Started

API Reference

Find Person 3.1

Query Parameters

Headers

Response

Error Responses

400

401

403

429 Too Many Requests

500 Internal Server Error

Get Started

API Reference

​Find Person 3.1

​Query Parameters

​Headers

​Response

​Error Responses

​400

​401

​403

​429 Too Many Requests

​500 Internal Server Error

Find Person 3.1

Query Parameters

Headers

Response

Error Responses

400

401

403

429 Too Many Requests

500 Internal Server Error