Skip to main content
GET
Retrieve verification
This page documents the Legacy API. For new integrations, use Retrieve Verification in the Current API.
Required permissions:
  • payout:account:read

Autorizaciones

Authorization
string
header
requerido

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

payout:account:read

Parámetros de ruta

id
string
requerido

The unique identifier of the verification to retrieve.

Ejemplo:

"verf_xxxxxxxxxxxxx"

Respuesta

A successful response

An identity verification session used to confirm a person or entity's identity for payout account eligibility.

id
string
requerido

The numeric id of the verification record.

Ejemplo:

"verf_xxxxxxxxxxxxx"

last_error_code
enum<string> | null
requerido

The most recent error code returned during verification. Null if no error has occurred.

Opciones disponibles:
abandoned,
consent_declined,
country_not_supported,
device_not_supported,
document_expired,
document_type_not_supported,
document_unverified_other,
email_unverified_other,
email_verification_declined,
id_number_insufficient_document_data,
id_number_mismatch,
id_number_unverified_other,
phone_unverified_other,
phone_verification_declined,
selfie_document_missing_photo,
selfie_face_mismatch,
selfie_manipulated,
selfie_unverified_other,
under_supported_age
last_error_reason
string | null
requerido

A human-readable explanation of the most recent verification error. Null if no error has occurred.

Ejemplo:

"Document image was too blurry to read."

status
enum<string>
requerido

The current status of this verification session.

Opciones disponibles:
requires_input,
processing,
verified,
canceled,
created,
started,
submitted,
approved,
declined,
resubmission_requested,
expired,
abandoned,
review,
action_required,
manual_review