Skip to main content
GET
Get Person Searches

Authorizations

X-API-Key
string
header
required

Query Parameters

q
string | null

The query param, can either be a search name or a search id. If it is a search id, it will be used to search by id. If it is a search name, it will be used to search by name. If it is not provided, it will be ignored.

limit
integer
default:10

Maximum number of records to return in a single page. Must be between 1 and 1000.

Required range: 1 <= x <= 1000
offset
integer | null

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

Required range: x >= 0
cursor
string | null

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

start_date
string<date> | null

Filter records created on or after this date (format: YYYY-MM-DD).

end_date
string<date> | null

Filter records created on or before this date (format: YYYY-MM-DD).

tz
string
default:UTC

IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

Examples:

"UTC"

"America/Los_Angeles"

"Europe/London"

Response

List of person searches.

id
string<uuid>
required

The unique identifier of the search.

state
enum<string>
required

The current state of the search.

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
created_at
string<date-time>
required

The datetime the search was created.

Example:

"2026-08-31T10:31:07.839963"

person
PersonResponse (v1) · object
required

The person to search for.

updated_at
string<date-time> | null

The datetime the search was updated at (generally when the search completed).

Example:

"2026-08-31T10:31:07.839973"

reference_id
string | null

The reference ID associated with the search.

Example:

"Search1234"

tin_matched
boolean | null

Whether the SSN for this person search matches with the name provided

Example:

true

error
string | null

Any errors that occurred.

Example:

"RuntimeError The Search could not be completed."

warnings
string[]

Any warnings that occurred.

Example:

"IRS Validation is unavailable."