Skip to main content
WEBHOOK

Body

application/json
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.

__event__
WebhookMetadata · object
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."

Response

Successful Response