Initiate Document Verification Session

curl --request POST \
  --url https://api.synctera.com/v2/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
}
'

import requests

url = "https://api.synctera.com/v2/verifications/docv_session"

payload = {
    "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "language": "EN-US",
    "send_message": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    person_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    language: 'EN-US',
    send_message: false
  })
};

fetch('https://api.synctera.com/v2/verifications/docv_session', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.synctera.com/v2/verifications/docv_session",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'person_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    'language' => 'EN-US',
    'send_message' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synctera.com/v2/verifications/docv_session"

	payload := strings.NewReader("{\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"language\": \"EN-US\",\n  \"send_message\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.synctera.com/v2/verifications/docv_session")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"language\": \"EN-US\",\n  \"send_message\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/verifications/docv_session")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"language\": \"EN-US\",\n  \"send_message\": false\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

POST

verifications

docv_session

Initiate Document Verification Session

curl --request POST \
  --url https://api.synctera.com/v2/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
}
'

import requests

url = "https://api.synctera.com/v2/verifications/docv_session"

payload = {
    "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "language": "EN-US",
    "send_message": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    person_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    language: 'EN-US',
    send_message: false
  })
};

fetch('https://api.synctera.com/v2/verifications/docv_session', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.synctera.com/v2/verifications/docv_session",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'person_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    'language' => 'EN-US',
    'send_message' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synctera.com/v2/verifications/docv_session"

	payload := strings.NewReader("{\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"language\": \"EN-US\",\n  \"send_message\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.synctera.com/v2/verifications/docv_session")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"language\": \"EN-US\",\n  \"send_message\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/verifications/docv_session")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"language\": \"EN-US\",\n  \"send_message\": false\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

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:

PASSPORT,

LICENSE

language

enum<string>

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

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:

PENDING,

COMPLETE

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"

string<uuid>

Unique ID for this document verification session.

Example:

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

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Initiate Document Verification Session

Authorizations

Headers

Body

Response