Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
ID Document check

Create an ID Document check

Create an ID Document check. Use Upload a file to get an upload_ref.

See also

Learn more about Id document checks
Learn more about Files

post/v1/checks/id_document

Request body

individual_idstring uuid required

Response

ID Document check has been created

ℹ️ Click to see full payload

idstring uuid required
individual_idstring uuid required
is_internalboolean required
status'in_progress' | 'need_review' | 'processing' | 'approved' | 'rejected' | 'expired' required

ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.

type'id_document' required
subtypestring nullable required

Currently always null for id_document Check

last_activity_atstring date-time required

Latest activity date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)