Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Document check

Create a Document check

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

See also

Learn more about Document checks
Learn more about Files

post/v1/checks/document

Request body

OR

Response

Document check has been created

ℹ️ Click to see full payload

idstring uuid required
company_idstring uuid nullable required
individual_idstring uuid nullable 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'document' required
subtypestring required

Contains "document_type:{settings.document_type_key}"

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)

Example response

{
  "data": {
    "settings": {
      "document_type": {
        "key": "some_key"
      }
    }
  }
}