Skip to main content
POST
/
verifications
/
docv_session
Initiate Document Verification Session
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/verifications/docv_session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "language": "EN-US",
  "send_message": false
}
'
{
  "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",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}

Documentation Index

Fetch the complete documentation index at: https://docs.synctera.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

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.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json
​
person_id
string<uuid>
required

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

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
document_type
enum<string>

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

Available options:
LICENSE,
PASSPORT
​
language
enum<string>

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)
Available options:
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
Example:

"EN-US"

​
send_message
boolean

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

Example:

false

Response

Created document verification session token.

​
person_id
string<uuid>
required

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

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
session_token
string
required

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

Example:

"907ce33a-c564-454e-a538-804efe31e6ac"

​
status
enum<string>
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.
Available options:
COMPLETE,
PENDING
Example:

"PENDING"

​
url
string
required

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

Example:

"https://verify.socure.com/session/907ce33a-c564-454e-a538-804efe31e6ac"

​
id
string<uuid>

Unique ID for this document verification session.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"