Person V2

Search for a person by name, phone number, and address

Retrieve person information with match scores and enriched emails.

Raises

StrictMatchWithFuzzyMatchingError If strict_match and include_fuzzy_matching are both set to true — the two flags are semantically contradictory.

get/v2/person/

Query parameters

phonestring nullable

Phone number to search for

Example:(216) 676-6366

Phone number to search for

emailstring nullable

Email address to search for

Example:user@example.com

Email address to search for

namestring nullable

Full name or partial name match

Example:Marsha Mellow

Full name or partial name match

first_namestring nullable

First name. Cannot be used with 'name'.

Example:Marsha

First name. Cannot be used with 'name'.

middle_namestring nullable

Middle name. Cannot be used with 'name'.

Example:Ann

Middle name. Cannot be used with 'name'.

last_namestring nullable

Last name. Cannot be used with 'name'.

Example:Mellow

Last name. Cannot be used with 'name'.

streetstring nullable

Street address including number and name

Example:123 Main St

Street address including number and name

citystring nullable

Full city name

Example:Anytown

Full city name

state_code'AL' | 'AK' | 'AZ' | 'AR' | 'AS' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'TT' | 'UT' | 'VT' | 'VA' | 'VI' | 'WA' | 'WV' | 'WI' | 'WY' nullable

Valid US State and Territory codes.

This enum contains all valid two-letter codes for US states and territories. Used for parameter validation in API requests.

Example:CA

2-Letter state code

zipcodestring nullable

Full 5-digit ZIP code

Example:94102

Full 5-digit ZIP code

include_historical_locationsboolean nullable

Include historical addresses in search

min_ageinteger nullable

Minimum age (18-65)

Example:18

Minimum age (18-65)

max_ageinteger nullable

Maximum age (18-65)

Example:35

Maximum age (18-65)

radiusnumber nullable

Search radius in miles

Example:2.5

Search radius in miles

include_fuzzy_matchingboolean nullable

Enable fuzzy name matching to broaden search results

strict_matchboolean nullable

Suppress automatic broadening. When true, the search does not fall back to fuzzy matching or radius expansion on a zero-result response; the exact query is authoritative.

pageinteger

Page number (1-indexed)

Example:1

Page number (1-indexed)

page_sizeinteger

Number of results per page

Example:5

Number of results per page

Response

Person data retrieved successfully

resultsPersonSearchResultDto[] required

Changes

No recorded changes to this endpoint across all 1 revision of this API.