Skip to main content
GET
List direct verifications

Authorizations

X-API-Key
string
header
required

Query Parameters

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.

sort
enum<string> | null

created_at (when it started) or updated_at (when it last changed); ties break on created_at, then the verification's id. Defaults to created_at desc. What the verifications list sorts by.

Available options:
created_at,
updated_at
sort_direction
enum<string> | null

asc or desc, for every key of the sort. Defaults to the field's own: created_at desc, updated_at desc.

Available options:
asc,
desc
reference_id
string | null

Only verifications started with this reference_id.

Maximum string length: 128
state
enum<string> | null

Only verifications in this state. A verification's lifecycle as a customer reads it: the workflow's states, with an internal stop reported as FAILED.

Available options:
PENDING,
EXECUTING,
WAITING,
COMPLETED,
FAILED,
EXPIRED
type
enum<string> | null

Only INDIVIDUAL or only BUSINESS verifications. What a verification verifies: an INDIVIDUAL alone, or an individual together with the BUSINESS they operate.

Available options:
INDIVIDUAL,
BUSINESS

Response

Paginated verifications in the requested order.

verification_id
string<uuid>
required

Unique id of the verification.

type
enum<string>
required

Whether a business is verified too.

Available options:
INDIVIDUAL,
BUSINESS
state
enum<string>
required

Lifecycle state of the verification workflow.

Available options:
PENDING,
EXECUTING,
WAITING,
COMPLETED,
FAILED,
EXPIRED
environment
enum<string>
required

The environment the verification ran in.

Available options:
sandbox,
production
created_at
string<date-time>
required

When the verification was created.

automated_verdict
enum<string> | null

What the checks concluded, APPROVED or UNDER_REVIEW; null until the verification completes.

Available options:
APPROVED,
UNDER_REVIEW,
REJECTED
verdict
enum<string> | null

The effective verdict: your reviewer's decision when one was made, otherwise automated_verdict.

Available options:
APPROVED,
UNDER_REVIEW,
REJECTED
terminal_reason
IdentitySubmissionTerminalReasonResponse (v1) · object | null

Typed state and detail when the workflow ended in FAILED; null otherwise.

individual_ref
string | null

Your pairwise reference to the verified individual, stable across re-verification; set once the verification completes and is approved.

business_ref
string | null

Your pairwise reference to the verified business, when the verification covered one.

Status of the individual-operates-business link as of this verification.

Available options:
VERIFIED,
UNDER_REVIEW,
REJECTED
reference_id
string | null

Caller-supplied correlation id.

idempotency_key
string | null

The Idempotency-Key the verification was created with.

completed_at
string<date-time> | null

When the verification reached a terminal status.