Skip to main content
GET
Get Person Search Status

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

Response

Successful Response

Represents a search status response.

id
string<uuid>
required

Unique identifier for the search.

state
enum<string>
required

The current state of the search.

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
Example:

"COMPLETED"

person
PersonResponse (v1) · object
required

The person being searched for.

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."