Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
KYC/KYB Verifications

Initiate Document Verification Session

Initiate document verification session to be used with /verifications/verify.

post/verifications/docv_session

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

document_type'LICENSE' | 'PASSPORT'

If provided, the document_type is used to constrain the type of document that can be collected from the end-customer.

language'AR' | 'AR-SA' | 'BN' | 'CS-CZ' | 'DA-DK' | 'DE-DE' | 'EN' | 'EN-AU' | 'EN-CA' | 'EN-GB' | 'EN-US' | 'ES' | 'ES-001' | 'ES-AR' | 'ES-ES' | 'ES-MX' | 'ES-US' | 'FI-FI' | 'FR' | 'FR-CA' | 'HE-IL' | 'HI-IN' | 'HT' | 'HU-HU' | 'HY' | 'ID-ID' | 'IT' | 'IT-CH' | 'JA-JP' | 'KO' | 'MS-MY' | 'NL-NL' | 'NO-NO' | 'PL-PL' | 'PT-BR' | 'PT-PT' | 'RO-MO' | 'RO-RO' | 'RU' | 'SK-SK' | 'SV-SE' | 'TH-TH' | 'TL' | 'TR-TR' | 'UR' | 'VI' | 'ZH-CN' | 'ZH-HK' | 'ZH-TW'

The language to be used in the document verification session. If not provided, defaults to EN-US. One of the following:

  • AR – Arabic
  • AR-SA – Arabic (Saudi Arabia)
  • BN – Bengali
  • CS-CZ – Czech (Czech Republic)
  • DA-DK – Danish (Denmark)
  • DE-DE – German (Germany)
  • EN – English
  • EN-AU – English (Australia)
  • EN-CA – English (Canada)
  • EN-GB – English (United Kingdom)
  • EN-US – English (United States)
  • ES – Spanish
  • ES-001 – Spanish (World)
  • ES-AR – Spanish (Argentina)
  • ES-ES – Spanish (Spain)
  • ES-MX – Spanish (Mexico)
  • ES-US – Spanish (United States)
  • FI-FI – Finnish (Finland)
  • FR – French
  • FR-CA – French (Canada)
  • HE-IL – Hebrew (Israel)
  • HI-IN – Hindi (India)
  • HT – Haitian Creole
  • HU-HU – Hungarian (Hungary)
  • HY – Armenian
  • ID-ID – Indonesian (Indonesia)
  • IT – Italian
  • IT-CH – Italian (Switzerland)
  • JA-JP – Japanese (Japan)
  • KO – Korean
  • MS-MY – Malay (Malaysia)
  • NL-NL – Dutch (Netherlands)
  • NO-NO – Norwegian (Norway)
  • PL-PL – Polish (Poland)
  • PT-BR – Portuguese (Brazil)
  • PT-PT – Portuguese (Portugal)
  • RO-MO – Romanian (Moldova)
  • RO-RO – Romanian (Romania)
  • RU – Russian
  • SK-SK – Slovak (Slovakia)
  • SV-SE – Swedish (Sweden)
  • TH-TH – Thai (Thailand)
  • TL – Tagalog
  • TR-TR – Turkish (Turkey)
  • UR – Urdu
  • VI – Vietnamese
  • ZH-CN – Chinese (Simplified, China)
  • ZH-HK – Chinese (Traditional, Hong Kong)
  • ZH-TW – Chinese (Traditional, Taiwan)
person_idstring uuid required

Unique ID for the person. Exactly one of person_id or business_id must be set.

send_messageboolean

Send an SMS containing the document verification link to the end-customer using the phone number provided on the customer record.

Example request

{
  "language": "EN-US",
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}

Response

Created document verification session token.

idstring uuid

Unique ID for this document verification session.

person_idstring uuid required

Unique ID for the person. Exactly one of person_id or business_id must be set.

session_tokenstring required

ID of the document verification session to be used in /verifications/verify request.

status'COMPLETE' | 'PENDING' required

The current state of the document verification session. One of the following:

  • PENDING – the session is pending verification.
  • COMPLETE – the end-customer has submitted the requested documents.
urlstring required

URL of the document verification session which can be shared with the end-customer.

Example response

{
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "session_token": "907ce33a-c564-454e-a538-804efe31e6ac",
  "status": "PENDING",
  "url": "https://verify.socure.com/session/907ce33a-c564-454e-a538-804efe31e6ac"
}