Skip to main content
GET
/
3.1
/
person
GET https://api.trestleiq.com/3.1/person?name={name}&address.city={city}&address.state_code={state}

{
  "count_person": 123,
  "person": [
    {}
  ],
  "error": {},
  "warnings": [
    {}
  ]
}

​
Overview

Find Person API provides the person’s details, including demographics, all current and historical addresses, phone numbers, and relatives and associates to this person.

​
Endpoint

GET https://api.trestleiq.com/3.1/person?name={name}&address.city={city}&address.state_code={state}

​
Parameters

​
name
string
required
The name of the person to search. Example: John Doe
​
address.street_line_1
string
The first line of the street part in the structured address.
​
address.street_line_2
string
The second line of the street part in the structured address.
​
address.city
string
The name of the city in the structured address. Example: Seattle
​
address.postal_code
string
The postal code of the structured address. Example: 98101
​
address.state_code
string
The state code of the structured address. Example: WA
​
address.country_code
string
The ISO-3166 alpha-2 country code of the address. Example: US

​
Headers

​
x-api-key
string
required
Your API key for authentication.

​
Code Examples

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"
Postman payload 
{
  "method": "GET",
  "url": "https://api.trestleiq.com/3.1/person",
  "query": {
    "name": "John Doe",
    "address.city": "Seattle",
    "address.state_code": "WA"
  },
  "headers": { "x-api-key": "YOUR_API_KEY" }
}

​
Response

​
count_person
integer
The number of people returned.
​
person
array
An array of people associated with the address provided. Each person object includes: - Demographics - All current and historical addresses - Phone numbers - Relatives and associates
​
error
object
Error information if the request failed.
​
warnings
array
Warnings returned as part of the response. Possible values include: Missing Input, Invalid Input Address, Invalid house/building number, Missing unit/apt/suite number, or Invalid unit/apt/suite number.