Create a verification
curl --request POST \
--url https://api.synctera.com/v2/verifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"result": "ACCEPTED",
"verification_time": "2023-11-07T05:31:56Z",
"verification_type": "IDENTITY",
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"details": [
{
"description": "Email address is correlated with the individual's name",
"result": "PASS",
"score": 0.25,
"url": "http://example.com/additional-information",
"vendor_code": "R940"
}
],
"metadata": {},
"person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"required_documents": [],
"vendor_info": {
"content_type": "application/json",
"json": {},
"vendor": "SOCURE"
}
}
EOFimport requests
url = "https://api.synctera.com/v2/verifications"
payload = {
"result": "ACCEPTED",
"verification_time": "2023-11-07T05:31:56Z",
"verification_type": "IDENTITY",
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"details": [
{
"description": "Email address is correlated with the individual's name",
"result": "PASS",
"score": 0.25,
"url": "http://example.com/additional-information",
"vendor_code": "R940"
}
],
"metadata": {},
"person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"required_documents": [],
"vendor_info": {
"content_type": "application/json",
"json": {},
"vendor": "SOCURE"
}
}
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({
result: 'ACCEPTED',
verification_time: '2023-11-07T05:31:56Z',
verification_type: 'IDENTITY',
business_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
details: [
{
description: 'Email address is correlated with the individual\'s name',
result: 'PASS',
score: 0.25,
url: 'http://example.com/additional-information',
vendor_code: 'R940'
}
],
metadata: {},
person_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
required_documents: [],
vendor_info: {content_type: 'application/json', json: {}, vendor: 'SOCURE'}
})
};
fetch('https://api.synctera.com/v2/verifications', 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",
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([
'result' => 'ACCEPTED',
'verification_time' => '2023-11-07T05:31:56Z',
'verification_type' => 'IDENTITY',
'business_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'details' => [
[
'description' => 'Email address is correlated with the individual\'s name',
'result' => 'PASS',
'score' => 0.25,
'url' => 'http://example.com/additional-information',
'vendor_code' => 'R940'
]
],
'metadata' => [
],
'person_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'required_documents' => [
],
'vendor_info' => [
'content_type' => 'application/json',
'json' => [
],
'vendor' => 'SOCURE'
]
]),
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"
payload := strings.NewReader("{\n \"result\": \"ACCEPTED\",\n \"verification_time\": \"2023-11-07T05:31:56Z\",\n \"verification_type\": \"IDENTITY\",\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"details\": [\n {\n \"description\": \"Email address is correlated with the individual's name\",\n \"result\": \"PASS\",\n \"score\": 0.25,\n \"url\": \"http://example.com/additional-information\",\n \"vendor_code\": \"R940\"\n }\n ],\n \"metadata\": {},\n \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"required_documents\": [],\n \"vendor_info\": {\n \"content_type\": \"application/json\",\n \"json\": {},\n \"vendor\": \"SOCURE\"\n }\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"result\": \"ACCEPTED\",\n \"verification_time\": \"2023-11-07T05:31:56Z\",\n \"verification_type\": \"IDENTITY\",\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"details\": [\n {\n \"description\": \"Email address is correlated with the individual's name\",\n \"result\": \"PASS\",\n \"score\": 0.25,\n \"url\": \"http://example.com/additional-information\",\n \"vendor_code\": \"R940\"\n }\n ],\n \"metadata\": {},\n \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"required_documents\": [],\n \"vendor_info\": {\n \"content_type\": \"application/json\",\n \"json\": {},\n \"vendor\": \"SOCURE\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/verifications")
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 \"result\": \"ACCEPTED\",\n \"verification_time\": \"2023-11-07T05:31:56Z\",\n \"verification_type\": \"IDENTITY\",\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"details\": [\n {\n \"description\": \"Email address is correlated with the individual's name\",\n \"result\": \"PASS\",\n \"score\": 0.25,\n \"url\": \"http://example.com/additional-information\",\n \"vendor_code\": \"R940\"\n }\n ],\n \"metadata\": {},\n \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"required_documents\": [],\n \"vendor_info\": {\n \"content_type\": \"application/json\",\n \"json\": {},\n \"vendor\": \"SOCURE\"\n }\n}"
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": "ADDRESS",
"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"
}KYC/KYB Verifications
Create a verification
Upload evidence of an externally performed KYC/KYB.
You may use your own KYC/KYB provider and upload evidence of those results instead of using one of Synctera’s providers.
Verifying a personal customer requires that the following fields already be set:
first_namelast_namedobemailorphone_numberlegal_addressshippings_addressssnor at least one other identifier inpersonal_ids
Verifying a business customer requires that the following fields already be set:
entity_namelegal_addressemailorphone_numbereinnot required for sole proprietorships
Please refer to https://learn.synctera.com/docs/using-your-own-kyc-vendor for more details using external KYC/KYB.
POST
/
verifications
Create a verification
curl --request POST \
--url https://api.synctera.com/v2/verifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"result": "ACCEPTED",
"verification_time": "2023-11-07T05:31:56Z",
"verification_type": "IDENTITY",
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"details": [
{
"description": "Email address is correlated with the individual's name",
"result": "PASS",
"score": 0.25,
"url": "http://example.com/additional-information",
"vendor_code": "R940"
}
],
"metadata": {},
"person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"required_documents": [],
"vendor_info": {
"content_type": "application/json",
"json": {},
"vendor": "SOCURE"
}
}
EOFimport requests
url = "https://api.synctera.com/v2/verifications"
payload = {
"result": "ACCEPTED",
"verification_time": "2023-11-07T05:31:56Z",
"verification_type": "IDENTITY",
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"details": [
{
"description": "Email address is correlated with the individual's name",
"result": "PASS",
"score": 0.25,
"url": "http://example.com/additional-information",
"vendor_code": "R940"
}
],
"metadata": {},
"person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"required_documents": [],
"vendor_info": {
"content_type": "application/json",
"json": {},
"vendor": "SOCURE"
}
}
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({
result: 'ACCEPTED',
verification_time: '2023-11-07T05:31:56Z',
verification_type: 'IDENTITY',
business_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
details: [
{
description: 'Email address is correlated with the individual\'s name',
result: 'PASS',
score: 0.25,
url: 'http://example.com/additional-information',
vendor_code: 'R940'
}
],
metadata: {},
person_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
required_documents: [],
vendor_info: {content_type: 'application/json', json: {}, vendor: 'SOCURE'}
})
};
fetch('https://api.synctera.com/v2/verifications', 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",
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([
'result' => 'ACCEPTED',
'verification_time' => '2023-11-07T05:31:56Z',
'verification_type' => 'IDENTITY',
'business_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'details' => [
[
'description' => 'Email address is correlated with the individual\'s name',
'result' => 'PASS',
'score' => 0.25,
'url' => 'http://example.com/additional-information',
'vendor_code' => 'R940'
]
],
'metadata' => [
],
'person_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'required_documents' => [
],
'vendor_info' => [
'content_type' => 'application/json',
'json' => [
],
'vendor' => 'SOCURE'
]
]),
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"
payload := strings.NewReader("{\n \"result\": \"ACCEPTED\",\n \"verification_time\": \"2023-11-07T05:31:56Z\",\n \"verification_type\": \"IDENTITY\",\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"details\": [\n {\n \"description\": \"Email address is correlated with the individual's name\",\n \"result\": \"PASS\",\n \"score\": 0.25,\n \"url\": \"http://example.com/additional-information\",\n \"vendor_code\": \"R940\"\n }\n ],\n \"metadata\": {},\n \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"required_documents\": [],\n \"vendor_info\": {\n \"content_type\": \"application/json\",\n \"json\": {},\n \"vendor\": \"SOCURE\"\n }\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"result\": \"ACCEPTED\",\n \"verification_time\": \"2023-11-07T05:31:56Z\",\n \"verification_type\": \"IDENTITY\",\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"details\": [\n {\n \"description\": \"Email address is correlated with the individual's name\",\n \"result\": \"PASS\",\n \"score\": 0.25,\n \"url\": \"http://example.com/additional-information\",\n \"vendor_code\": \"R940\"\n }\n ],\n \"metadata\": {},\n \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"required_documents\": [],\n \"vendor_info\": {\n \"content_type\": \"application/json\",\n \"json\": {},\n \"vendor\": \"SOCURE\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/verifications")
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 \"result\": \"ACCEPTED\",\n \"verification_time\": \"2023-11-07T05:31:56Z\",\n \"verification_type\": \"IDENTITY\",\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"details\": [\n {\n \"description\": \"Email address is correlated with the individual's name\",\n \"result\": \"PASS\",\n \"score\": 0.25,\n \"url\": \"http://example.com/additional-information\",\n \"vendor_code\": \"R940\"\n }\n ],\n \"metadata\": {},\n \"person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"required_documents\": [],\n \"vendor_info\": {\n \"content_type\": \"application/json\",\n \"json\": {},\n \"vendor\": \"SOCURE\"\n }\n}"
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": "ADDRESS",
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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
Verification result to create.
Verification result.
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:
ACCEPTED, PENDING, PROVISIONAL, REJECTED, REVIEW, UNVERIFIED, VENDOR_ERROR Example:
"ACCEPTED"
The date and time the verification was completed.
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:
DOCUMENT_VERIFICATION, IDENTITY, LICENSE, MANUAL_REVIEW, RELATED_ENTITIES, WATCHLIST Example:
"IDENTITY"
Unique ID for the business. Exactly one of business_id or person_id must be set.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
A list of individual checks done as part of the due diligence process for the verification type.
Show child attributes
Show child attributes
Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
Unique ID for the person. Exactly one of person_id or business_id must be set.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
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 The information provided to Synctera from the vendor. Interpretation of this object is up to the client.
- Vendor Info
- Vendor Info
Show child attributes
Show child attributes
Response
Created verification.
Verification result.
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:
ACCEPTED, PENDING, PROVISIONAL, REJECTED, REVIEW, UNVERIFIED, VENDOR_ERROR Example:
"ACCEPTED"
The date and time the verification was completed.
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:
DOCUMENT_VERIFICATION, IDENTITY, LICENSE, MANUAL_REVIEW, RELATED_ENTITIES, WATCHLIST Example:
"IDENTITY"
Unique ID for the business. Exactly one of business_id or person_id must be set.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
The date and time the resource was created.
Example:
"2010-05-06T12:23:34.321Z"
Indicates whether the verification was initiated by the customer.
A list of individual checks done as part of the due diligence process for the verification type.
Show child attributes
Show child attributes
Unique ID for this verification result.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
The date and time the resource was last updated.
Example:
"2010-05-06T12:23:34.321Z"
Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
Unique ID for the person. Exactly one of person_id or business_id must be set.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
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 The information provided to Synctera from the vendor. Interpretation of this object is up to the client.
- Vendor Info
- Vendor Info
Show child attributes
Show child attributes
Was this page helpful?