Get verification

curl --request GET \
  --url https://api.synctera.com/v2/verifications/{verification_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.synctera.com/v2/verifications/{verification_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v2/verifications/{verification_id}', 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/{verification_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.synctera.com/v2/verifications/{verification_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/verifications/{verification_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "result": "ACCEPTED",
  "verification_time": "2023-11-07T05:31:56Z",
  "verification_type": "IDENTITY",
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "customer_initiated": true,
  "details": [
    {
      "category": "WATCHLIST",
      "description": "Email address is correlated with the individual's name",
      "label": "Email",
      "result": "PASS",
      "score": 0.25,
      "url": "http://example.com/additional-information",
      "vendor_code": "R940"
    }
  ],
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "metadata": {},
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "required_documents": [
    "ADDRESS_VERIFICATION"
  ],
  "vendor_info": {
    "content_type": "application/json",
    "json": {},
    "vendor": "SOCURE"
  }
}

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

GET

verifications

{verification_id}

Get verification

curl --request GET \
  --url https://api.synctera.com/v2/verifications/{verification_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.synctera.com/v2/verifications/{verification_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v2/verifications/{verification_id}', 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/{verification_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.synctera.com/v2/verifications/{verification_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/verifications/{verification_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "result": "ACCEPTED",
  "verification_time": "2023-11-07T05:31:56Z",
  "verification_type": "IDENTITY",
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "customer_initiated": true,
  "details": [
    {
      "category": "WATCHLIST",
      "description": "Email address is correlated with the individual's name",
      "label": "Email",
      "result": "PASS",
      "score": 0.25,
      "url": "http://example.com/additional-information",
      "vendor_code": "R940"
    }
  ],
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "metadata": {},
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "required_documents": [
    "ADDRESS_VERIFICATION"
  ],
  "vendor_info": {
    "content_type": "application/json",
    "json": {},
    "vendor": "SOCURE"
  }
}

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

Path Parameters

verification_id

string<uuid>

required

Verification's unique identifier.

Example:

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

Response

Verification representation.

Verification result.

result

enum<string>

required

The determination of this verification. One of the following:

UNVERIFIED – record representing the absence of a verification.
PENDING – verification is in progress for this customer.
PROVISIONAL – partially verified or verified with restrictions.
ACCEPTED – the customer has been verified.
REVIEW – verification has run and issues have been identified and require review.
VENDOR_ERROR – verification did not successfully run due to an unexpected error or failure.
REJECTED – the customer was rejected and should not be allowed to take certain actions e.g., open an account.

Available options:

UNVERIFIED,

PENDING,

PROVISIONAL,

ACCEPTED,

REVIEW,

VENDOR_ERROR,

REJECTED

Example:

"ACCEPTED"

verification_time

string<date-time>

required

The date and time the verification was completed.

verification_type

enum<string>

required

The verification run on the customer. One the following:

IDENTITY – verify that the information provided is associated with the identity of a real person or business.
WATCHLIST – checks watchlists for known fraud, money laundering, and other suspicious activity.
DOCUMENT_VERIFICATION – verifies the authenticity of a document, such as a driver's license, or other government-issued identification document.
RELATED_ENTITIES – represents dependent verification checks for related parties (e.g. all beneficial owners must pass KYC for a business to pass KYB).
MANUAL_REVIEW – represents the outcome of a manual review of the verification done on a party (note: overrides the outcome of other verification types).
LICENSE – represents the outcome of a license verification.

Available options:

IDENTITY,

WATCHLIST,

DOCUMENT_VERIFICATION,

RELATED_ENTITIES,

MANUAL_REVIEW,

LICENSE

Example:

"IDENTITY"

business_id

string<uuid>

The unique identifier of a business

Example:

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

creation_time

string<date-time>

read-only

The date and time the resource was created.

Example:

"2010-05-06T12:23:34.321Z"

customer_initiated

boolean

read-only

Indicates whether the verification was initiated by the customer.

details

object[]

A list of individual checks done as part of the due diligence process for the verification type.

Show child attributes

string<uuid>

read-only

Unique ID for this verification result.

Example:

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

last_updated_time

string<date-time>

read-only

The date and time the resource was last updated.

Example:

"2010-05-06T12:23:34.321Z"

metadata

object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

person_id

string<uuid>

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

Example:

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

required_documents

enum<string>[]

A list of required documents for follow-up collection to progress the verification.

Machine-readable identifier to indicate the required documents to advance the case review.

ADDRESS_VERIFICATION — Documentation to validate the customer's legal address:

Driver’s License or State ID with address
Utility Bill (issued within 60 days)
Bank Statement (issued within 60 days)
Pay Stub (issued within 60 days)
Lease Agreement

ID_DOCUMENT — Documentation to validate the customer's identity:

Government-issued Driver's License
State ID
Passport

SSN_VERIFICATION — Documentation to validate the customer's Social Security Number:

Social Security Card
Recent Tax Return (e.g., 1040)
W-2 or 1099

Available options:

ADDRESS_VERIFICATION,

ID_DOCUMENT,

SSN_VERIFICATION

vendor_info

Vendor Info · object

The information provided to Synctera from the vendor. Interpretation of this object is up to the client.

Vendor Info
Vendor Info

Show child attributes

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Get verification

Authorizations

Path Parameters

Response