List verification requests

GET

/requests

• Production

Returns a paginated list of verification requests for your organization.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

type

string

Allowed values: idv kyc share

Filter by verification type

status

string

Filter by status. Accepts a single value or comma-separated list. Valid values: initiated, in_progress, submitted, pending_review, approved, rejected, canceled, expired

clientId

string format: uuid

Filter by client ID

matterId

string format: uuid

Filter by matter ID

search

string

<= 100 characters

Search by subject name or email

dateFrom

string format: date-time

Filter requests created on or after this ISO 8601 date

dateTo

string format: date-time

Filter requests created on or before this ISO 8601 date

sort

string

Allowed values: created_at updated_at status

Sort field (default created_at descending)

page

integer

default: 1 >= 1

limit

integer

default: 20 >= 1 <= 100

Responses

200

Paginated list of requests

object

data

Array<object>

object

id

string

orgId

string

type

string

Allowed values: idv kyc share

status

string

Allowed values: initiated in_progress submitted pending_review approved rejected canceled expired

requirements

Array<string>

currentStep

string

nullable

subjectName

string

nullable

subjectEmail

string

nullable

subjectPhone

string

nullable

requestorName

string

nullable

requestorEmail

string

nullable

requestorCompany

string

nullable

clientId

string

nullable

matterId

string

nullable

expiresDays

integer

expiresAt

string format: date-time

submittedAt

string format: date-time

nullable

accessToken

Token used in the subject-facing verification URL

string

createdAt

string format: date-time

updatedAt

string format: date-time

pagination

object

page

integer

limit

integer

total

integer

totalPages

integer

hasNext

boolean

hasPrev

boolean

401

Missing or invalid API key

object

code

string

message

string

statusCode

integer

Example

{
  "code": "UNAUTHORIZED",
  "message": "Invalid API key.",
  "statusCode": 401
}

429

Too many requests

object

code

string

message

string

statusCode

integer

Example

{
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "statusCode": 429
}

Headers

Retry-After

integer

Seconds until the rate limit window resets

X-RateLimit-Limit

integer

X-RateLimit-Remaining

integer