Person V2

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

Changed on

Retrieve person information with match scores and enriched emails.

strict_match and include_fuzzy_matching are contradictory, so enabling both on one request is rejected. Either alone is fine, and so is sending both with one of them false.

get/v2/person/

Request

Query parameters

phonestring nullable

Phone number to search for

Example:(216) 676-6366
emailstring nullable

Email address to search for

Example:user@example.com
namestring nullable

Full name or partial name match

Example:Marsha Mellow
first_namestring nullable

First name. Cannot be used with 'name'.

Example:Marsha
middle_namestring nullable

Middle name. Cannot be used with 'name'.

Example:Ann
last_namestring nullable

Last name. Cannot be used with 'name'.

Example:Mellow
streetstring nullable

Street address including number and name

Example:123 Main St
citystring nullable

Full city name

Example:Anytown
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
include_historical_locationsboolean nullable

Include historical addresses in search

min_ageinteger nullable

Minimum age (18-65)

Example:18
max_ageinteger nullable

Maximum age (18-65)

Example:35
radiusnumber nullable

Search radius in miles

Example:2.5
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_sizeinteger

Number of results per page

Example:5

Response

Person data retrieved successfully

Changes

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • info

      removed the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed subschema #2 from the / response property anyOf list for the response status

    • info

      removed subschema #2 from the / response property anyOf list for the response status

    • info

      the response's property default value 422 was added for the status

    • info

      the response's property default value 500 was added for the status

    • info

      the response's property default value Internal Server Error was added for the status

    • info

      the response's property default value Unprocessable Entity was added for the status

    • info

      removed the 100.00 enum value from the / response property for the response status

    • info

      removed the 100.00 enum value from the / response property for the response status

    • info

      removed the 101.00 enum value from the / response property for the response status

    • info

      removed the 101.00 enum value from the / response property for the response status

    • info

      removed the 102.00 enum value from the / response property for the response status

    • info

      removed the 102.00 enum value from the / response property for the response status

    • info

      removed the 103.00 enum value from the / response property for the response status

    • info

      removed the 103.00 enum value from the / response property for the response status

    • info

      removed the 200.00 enum value from the / response property for the response status

    • info

      removed the 200.00 enum value from the / response property for the response status

    • info

      removed the 201.00 enum value from the / response property for the response status

    • info

      removed the 201.00 enum value from the / response property for the response status

    • info

      removed the 202.00 enum value from the / response property for the response status

    • info

      removed the 202.00 enum value from the / response property for the response status

    • info

      removed the 203.00 enum value from the / response property for the response status

    • info

      removed the 203.00 enum value from the / response property for the response status

    • info

      removed the 204.00 enum value from the / response property for the response status

    • info

      removed the 204.00 enum value from the / response property for the response status

    • info

      removed the 205.00 enum value from the / response property for the response status

    • info

      removed the 205.00 enum value from the / response property for the response status

    • info

      removed the 206.00 enum value from the / response property for the response status

    • info

      removed the 206.00 enum value from the / response property for the response status

    • info

      removed the 207.00 enum value from the / response property for the response status

    • info

      removed the 207.00 enum value from the / response property for the response status

    • info

      removed the 208.00 enum value from the / response property for the response status

    • info

      removed the 208.00 enum value from the / response property for the response status

    • info

      removed the 226.00 enum value from the / response property for the response status

    • info

      removed the 226.00 enum value from the / response property for the response status

    • info

      removed the 300.00 enum value from the / response property for the response status

    • info

      removed the 300.00 enum value from the / response property for the response status

    • info

      removed the 301.00 enum value from the / response property for the response status

    • info

      removed the 301.00 enum value from the / response property for the response status

    • info

      removed the 302.00 enum value from the / response property for the response status

    • info

      removed the 302.00 enum value from the / response property for the response status

    • info

      removed the 303.00 enum value from the / response property for the response status

    • info

      removed the 303.00 enum value from the / response property for the response status

    • info

      removed the 304.00 enum value from the / response property for the response status

    • info

      removed the 304.00 enum value from the / response property for the response status

    • info

      removed the 305.00 enum value from the / response property for the response status

    • info

      removed the 305.00 enum value from the / response property for the response status

    • info

      removed the 307.00 enum value from the / response property for the response status

    • info

      removed the 307.00 enum value from the / response property for the response status

    • info

      removed the 308.00 enum value from the / response property for the response status

    • info

      removed the 308.00 enum value from the / response property for the response status

    • info

      removed the 400.00 enum value from the / response property for the response status

    • info

      removed the 400.00 enum value from the / response property for the response status

    • info

      removed the 401.00 enum value from the / response property for the response status

    • info

      removed the 401.00 enum value from the / response property for the response status

    • info

      removed the 402.00 enum value from the / response property for the response status

    • info

      removed the 402.00 enum value from the / response property for the response status

    • info

      removed the 403.00 enum value from the / response property for the response status

    • info

      removed the 403.00 enum value from the / response property for the response status

    • info

      removed the 404.00 enum value from the / response property for the response status

    • info

      removed the 404.00 enum value from the / response property for the response status

    • info

      removed the 405.00 enum value from the / response property for the response status

    • info

      removed the 405.00 enum value from the / response property for the response status

    • info

      removed the 406.00 enum value from the / response property for the response status

    • info

      removed the 406.00 enum value from the / response property for the response status

    • info

      removed the 407.00 enum value from the / response property for the response status

    • info

      removed the 407.00 enum value from the / response property for the response status

    • info

      removed the 408.00 enum value from the / response property for the response status

    • info

      removed the 408.00 enum value from the / response property for the response status

    • info

      removed the 409.00 enum value from the / response property for the response status

    • info

      removed the 409.00 enum value from the / response property for the response status

    • info

      removed the 410.00 enum value from the / response property for the response status

    • info

      removed the 410.00 enum value from the / response property for the response status

    • info

      removed the 411.00 enum value from the / response property for the response status

    • info

      removed the 411.00 enum value from the / response property for the response status

    • info

      removed the 412.00 enum value from the / response property for the response status

    • info

      removed the 412.00 enum value from the / response property for the response status

    • info

      removed the 413.00 enum value from the / response property for the response status

    • info

      removed the 413.00 enum value from the / response property for the response status

    • info

      removed the 413.00 enum value from the / response property for the response status

    • info

      removed the 413.00 enum value from the / response property for the response status

    • info

      removed the 414.00 enum value from the / response property for the response status

    • info

      removed the 414.00 enum value from the / response property for the response status

    • info

      removed the 414.00 enum value from the / response property for the response status

    • info

      removed the 414.00 enum value from the / response property for the response status

    • info

      removed the 415.00 enum value from the / response property for the response status

    • info

      removed the 415.00 enum value from the / response property for the response status

    • info

      removed the 416.00 enum value from the / response property for the response status

    • info

      removed the 416.00 enum value from the / response property for the response status

    • info

      removed the 416.00 enum value from the / response property for the response status

    • info

      removed the 416.00 enum value from the / response property for the response status

    • info

      removed the 417.00 enum value from the / response property for the response status

    • info

      removed the 417.00 enum value from the / response property for the response status

    • info

      removed the 418.00 enum value from the / response property for the response status

    • info

      removed the 418.00 enum value from the / response property for the response status

    • info

      removed the 421.00 enum value from the / response property for the response status

    • info

      removed the 421.00 enum value from the / response property for the response status

    • info

      removed the 422.00 enum value from the / response property for the response status

    • info

      removed the 422.00 enum value from the / response property for the response status

    • info

      removed the 422.00 enum value from the / response property for the response status

    • info

      removed the 422.00 enum value from the / response property for the response status

    • info

      removed the 423.00 enum value from the / response property for the response status

    • info

      removed the 423.00 enum value from the / response property for the response status

    • info

      removed the 424.00 enum value from the / response property for the response status

    • info

      removed the 424.00 enum value from the / response property for the response status

    • info

      removed the 425.00 enum value from the / response property for the response status

    • info

      removed the 425.00 enum value from the / response property for the response status

    • info

      removed the 426.00 enum value from the / response property for the response status

    • info

      removed the 426.00 enum value from the / response property for the response status

    • info

      removed the 428.00 enum value from the / response property for the response status

    • info

      removed the 428.00 enum value from the / response property for the response status

    • info

      removed the 429.00 enum value from the / response property for the response status

    • info

      removed the 429.00 enum value from the / response property for the response status

    • info

      removed the 431.00 enum value from the / response property for the response status

    • info

      removed the 431.00 enum value from the / response property for the response status

    • info

      removed the 451.00 enum value from the / response property for the response status

    • info

      removed the 451.00 enum value from the / response property for the response status

    • info

      removed the 500.00 enum value from the / response property for the response status

    • info

      removed the 500.00 enum value from the / response property for the response status

    • info

      removed the 501.00 enum value from the / response property for the response status

    • info

      removed the 501.00 enum value from the / response property for the response status

    • info

      removed the 502.00 enum value from the / response property for the response status

    • info

      removed the 502.00 enum value from the / response property for the response status

    • info

      removed the 503.00 enum value from the / response property for the response status

    • info

      removed the 503.00 enum value from the / response property for the response status

    • info

      removed the 504.00 enum value from the / response property for the response status

    • info

      removed the 504.00 enum value from the / response property for the response status

    • info

      removed the 505.00 enum value from the / response property for the response status

    • info

      removed the 505.00 enum value from the / response property for the response status

    • info

      removed the 506.00 enum value from the / response property for the response status

    • info

      removed the 506.00 enum value from the / response property for the response status

    • info

      removed the 507.00 enum value from the / response property for the response status

    • info

      removed the 507.00 enum value from the / response property for the response status

    • info

      removed the 508.00 enum value from the / response property for the response status

    • info

      removed the 508.00 enum value from the / response property for the response status

    • info

      removed the 510.00 enum value from the / response property for the response status

    • info

      removed the 510.00 enum value from the / response property for the response status

    • info

      removed the 511.00 enum value from the / response property for the response status

    • info

      removed the 511.00 enum value from the / response property for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      endpoint added