Models

Synaps API response models

Reasons Code

code	description
FORGED_REJECTION	The document has been rejected because it is a forgery
DOCUMENT_HIDDEN	The document has been rejected because it lacks visibility
BAD_ENVIRONMENT	The document has been rejected because the environment is not suitable
BLACK_WHITE_PICTURE	The document has been rejected because it is black and white
BAD_QUALITY	The document has been rejected because it is of poor quality
DOCUMENT_COMPLIANCE	The document has been rejected because it does not comply with the requested document
IDENTITY_DOCUMENT_EXPIRED	The document has been rejected because it is expired
DOCUMENT_INVALID_FRONT_SIDE	The document has been rejected because the front side is invalid
DOCUMENT_INVALID_BACK_SIDE	The document has been rejected because the back side is invalid
IDENTITY_DOCUMENT_DOB_DATE_MINOR	The document has been rejected because the date of birth indicates that the person is a minor
RESTRICTED_NATIONALITY_TYPE	The document has been rejected because of the nationality
DUPLICATE_USER	User already submitted his document for this app

Status

Our status describe both the session and the step state. Here is a comprehensive list of all the possible values.

code	description
APPROVED	The step (or the KYC) has been validated by Synaps
SUBMISSION_REQUIRED	The step (or the KYC) wait for the customer to start the session
RESUBMISSION_REQUIRED	The step (or the KYC) wait for a re-submission from the session customer
REJECTED	The step (or the KYC) has been rejected by Synaps, the reason is available
PENDING_VERIFICATION	The step (or the KYC) is waiting for a verification from Synaps

File

Name
url
Type
string
Description
The file HTTP URL.
Name
type
Type
string(mime-type)
Description
The file mime-type.
Name
size
Type
number
Description
The Content-Length of the file.

{
    "url": "https://picsum.photos/200",
    "type": "image/jpeg",
    "size": 10120
}

Customer info

Name
firstname
Type
string
Description
Customer's firstname.
Name
lastname
Type
string
Description
Customer's lastname.
Name
birth_date
Type
string
Description
Customer's birth date.
Name
nationality
Type
string
Description
Customer's nationality.
Name
country
Type
string
Description
Customer's country of residence.

Hit

A hit is a AML match, which means the name potentially match a person who is on a money laundering sanction list.

Name
fields
Type
object[]
Description
An array of field objects related to the hit.
Name
aliases
Type
string[]
Description
An array of alias strings associated with the hit.
Name
media
Type
object[]
Description
An array of media objects related to the hit.
Name
info
Type
object
Description
Information about the hit.
- Name
  info.full_name
  Type
  string
  Description
  Full name associated with the hit.
- Name
  info.birth_date
  Type
  string
  Description
  Birth date associated with the hit.
- Name
  info.nationality
  Type
  string
  Description
  Nationality associated with the hit.
Name
type
Type
string[]
Description
An array of type strings associated with the hit.

Field

Fields are informations about the person associated with the hit. We use this to compare to actual document.

Name
countries
Type
object[]
Description
An array of country objects associated with the hit.
- Name
  countries.country_code
  Type
  string
  Description
  Country code of the associated country.
- Name
  countries.name
  Type
  string
  Description
  Name of the associated country.
Name
name
Type
string
Description
Name of the hit.
Name
source
Type
string
Description
Source of the hit.
Name
value
Type
object[]
Description
An array of name-value pair objects related to the hit.
- Name
  value.name
  Type
  string
  Description
  Name of the value.
- Name
  value.value
  Type
  string
  Description
  Actual value.
Name
tag
Type
string[]
Description
An array of tags associated with the hit.

Customer info

Name
firstname
Type
string
Description
Customer's firstname.
Name
lastname
Type
string
Description
Customer's lastname.
Name
birth_date
Type
string
Description
Customer's birth date.
Name
nationality
Type
string
Description
Customer's nationality.
Name
country
Type
string
Description
Customer's country of residence.

Media

Name
date
Type
string
Description
Date of the media.
Name
snippet
Type
string
Description
Snippet of the media.
Name
title
Type
string
Description
Title of the media.
Name
url
Type
string
Description
URL of the media.

AML Info

Name
full_name
Type
string
Description
The full name of the entity.
Name
entity_type
Type
string
Description
The type of entity.
Name
aka
Type
string[]
Description
An array of known aliases or alternative names for the entity.
Name
countries
Type
string
Description
The countries associated with the entity.
Name
birth_date
Type
string
Description
The birth date of the entity (if available).
Name
associates
Type
array
Description
An array of associates associated with the entity.

AML Screening listing

Name
types
Type
string[]
Description
An array of types associated with this entry.
Name
countries
Type
object[]
Description
An array of countries associated with this entry. Each country has the following properties:
Name
countries.country_code
Type
string
Description
The country code for the associated country.
Name
countries.name
Type
string
Description
The name of the associated country.
Name
name
Type
string
Description
The name associated with this entry.
Name
url
Type
string
Description
The URL associated with this entry.
Name
listing_ended
Type
string
Description
The date when the listing ended for this entry (if available).
Name
listing_started
Type
string
Description
The date when the listing started for this entry (if available).
Name
fields
Type
object[]
Description
An array of fields associated with this entry. Each field has the following properties.
Name
fields.name
Type
string
Description
The name of the field.
Name
fields.value
Type
string
Description
The value of the field.

AML reason

Name
reason
Type
string
Description
The reason for aml decision.
Name
note
Type
string
Description
A note related to aml decision reason.

Edge

Name
NodeID
Type
int
Description
The unique identifier for the connected entity.
Name
Shares
Type
float64
Description
The amount of shares associated with the connection (for corporates).
Name
Director
Type
bool
Description
Indicates whether the entity is a director in the connection (for corporates).

Match

Name
face
Type
url
Description
The URL of the face image. (available for 15 minutes)
Name
session_id
Type
string
Description
The session identifier of the match.
Name
similarity_score
Type
float64
Description
The similarity score of the match.