A well-formatted request looks like:
All parameters are case sensitive. api_key, name, and at least one address parameter is required for a Find Person Request. It is recommended to include name and address.postal_code or name, address.city and address.state_code at minimum.
|api_key||See here to acquire an API key. REQUIRED|
|name||Person name as a single parameter|
|address.street_line_1||Number and street name|
2808 Nero Blvd
|address.street_line_2||Apartment or other additional address information|
|address.postal_code||5 or 9 digit US or 6 digit Canadian zip code|
92019 or S3D 3F3
|address.state_code||2 character state code|
|address.country_code||Normalized country code|
CA or US
|search.historical||Expand search to include people who used to live at an address in the past. Possible values: true/false. By default, false.|
|search.metro||Expands search area to 30 mile radius from lat long of the input address. Possible values: true/false. By default, false.|
|search.name_match||Choice of precision in name matching: exact, phonetic, or nickname. By default, phonetic.|
|search.alternate_name||Expands matching results with alternate names considered. Possible values: true/false. By default, false.|
A Find Person response is formatted as follows.
Click the # to see that field used within the example JSON response.
Find Person Response
|2||personArray of objects|
Each object defined in the table below.
Id of the person.
Full name of the person.
First name of the person.
Middle name of the person.
Last name of the person.
Age range of the person.
Possible returns include: 18-24, 25-29, 30-34, 35-39, 40-44, 45-49, 50-54, 55-59, 60-64, 65+.
Gender of the person.
|8||current_addressesArray of objects|
A list of unique current locations associated with person
|9||historical_addressesArray of objects|
A list of unique historical locations associated with person. Format is the same as current_addresses
Includes id of the phones and phone numbers in E.164 which belong to the person.
A list of related and associated people to person.
Each object in the array will include: