Skip to content

Get a verification request

GET
/requests/{id}

Returns a single request with full assembled detail including step data, scores, and decisions.

id
required
string

Request ID

Assembled request 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
score

Composite verification score (0–100)

number
nullable
person

Identity step data

object
documents

Document step data

array
biometric

Biometric step data

object
location

Location step data

object
contact

Contact step data

object
business

Business step data

object
financial

Financial step data

object
pep

PEP screening results

object
steps

Step-by-step audit trail

array

Missing or invalid API key

object
code
string
message
string
statusCode
integer
Example
{
"code": "UNAUTHORIZED",
"message": "Invalid API key.",
"statusCode": 401
}

Resource not found

object
code
string
message
string
statusCode
integer
Example
{
"code": "NOT_FOUND",
"message": "Resource not found.",
"statusCode": 404
}

Too many requests

object
code
string
message
string
statusCode
integer
Example
{
"code": "RATE_LIMITED",
"message": "Too many requests",
"statusCode": 429
}
Retry-After
integer

Seconds until the rate limit window resets

X-RateLimit-Limit
integer
X-RateLimit-Remaining
integer