Automated Verification

Presentation

Synaps designed an Artificial Intelligence to automate identity verification at scale. It makes verifying user identity, documents’ security features and data consistency fast and easy. Everything is done through a single API request and returned with a complete breakdown of the identity check, with an option to generate a PDF certificate.

post
Create Session

https://auto-id-api.synaps.io/v1/session/create
For each verification, you have to create a session. A session is the unique identifier of your verification. You can create a new session_id using your API Key.
Request
Response
Request
Headers
Authorization
required
string
App API Key
Response
200: OK
{
"session_id": "nezaq5-OUSt7z-r7CsJA-rzU6wV"
"state": "CREATED"
}

API Response

Field

Type

Description

session_id

string

Session Identifier

get
Supported Documents List

https://auto-id-api.synaps.io/v1/documents/list
Return all the documents types and countries supported by the AI
Request
Response
Request
Response
200: OK
[
{
"country": "Sweden",
"country_code": "SWE",
"supported_documents": [
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "Argentina",
"country_code": "ARG",
"supported_documents": [
{
"name": "National ID",
"back_required": true
}
]
},
{
"country": "Australia",
"country_code": "AUS",
"supported_documents": [
{
"name": "Driver License",
"back_required": true
},
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "Romania",
"country_code": "ROU",
"supported_documents": [
{
"name": "Passport",
"back_required": false
},
{
"name": "Driver License",
"back_required": true
},
{
"name": "National ID",
"back_required": true
}
]
},
{
"country": "Netherlands",
"country_code": "NLD",
"supported_documents": [
{
"name": "Passport",
"back_required": false
},
{
"name": "Driver License",
"back_required": true
},
{
"name": "National ID",
"back_required": true
}
]
},
{
"country": "Portugal",
"country_code": "PRT",
"supported_documents": [
{
"name": "National ID",
"back_required": true
},
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "Spain",
"country_code": "ESP",
"supported_documents": [
{
"name": "National ID",
"back_required": true
},
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "Finland",
"country_code": "FIN",
"supported_documents": [
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "Italy",
"country_code": "ITA",
"supported_documents": [
{
"name": "National ID",
"back_required": true
},
{
"name": "Driver License",
"back_required": true
},
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "Germany",
"country_code": "DEU",
"supported_documents": [
{
"name": "Passport",
"back_required": false
},
{
"name": "National ID",
"back_required": true
},
{
"name": "Driver License",
"back_required": true
}
]
},
{
"country": "Belgium",
"country_code": "BEL",
"supported_documents": [
{
"name": "Passport",
"back_required": false
},
{
"name": "National ID",
"back_required": true
}
]
},
{
"country": "France",
"country_code": "FRA",
"supported_documents": [
{
"name": "National ID",
"back_required": true
},
{
"name": "Passport",
"back_required": false
},
{
"name": "Driver License",
"back_required": true
}
]
},
{
"country": "Austria",
"country_code": "AUT",
"supported_documents": [
{
"name": "National ID",
"back_required": true
},
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "Brazil",
"country_code": "BRA",
"supported_documents": [
{
"name": "Driver License",
"back_required": true
},
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "Poland",
"country_code": "POL",
"supported_documents": [
{
"name": "National ID",
"back_required": true
}
]
},
{
"country": "United Kingdom of Great Britain and Northern Ireland",
"country_code": "GBR",
"supported_documents": [
{
"name": "Driver License",
"back_required": true
},
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "Switzerland",
"country_code": "CHE",
"supported_documents": [
{
"name": "National ID",
"back_required": true
},
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "United States of America",
"country_code": "USA",
"supported_documents": [
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "Ireland",
"country_code": "IRL",
"supported_documents": [
{
"name": "Passport",
"back_required": false
}
]
},
{
"country": "Denmark",
"country_code": "DNK",
"supported_documents": [
{
"name": "Passport",
"back_required": false
}
]
}
]

API Response

Return an array of countries with their associated supported document type

Field

Type

Description

country

string

Name of the country

country_code

string

ISO-3166 country code

supported_documents

SuportedDocumentArray

An array of all supported document type of the current country

SuportedDocumentArray

Field

Type

Description

name

string

Passport, National ID, Driver License

back_required

bool

true if a back side is required

false if a back side is not required

post
Process Automatic Identity Verification

https://auto-id-api.synaps.io/v1/documents/verify
Return a full breakdown of the identity verification breakdown on a given ID
Request
Response
Request
Query Parameters
session_id
required
string
a valid session_id previously created must be provided
Form Data Parameters
country
optional
string
ISO Format of the country (ISO-3166 format)
back_document
optional
object
Document back image (PNG, JPEG, JPG. Max 8MB)
front_document
required
object
Document front image (PNG, JPEG, JPG. Max 8MB)
Response
200: OK
Certificate successfully generated.
{
"verification": {
"info": {
"firstname": {
"value": "JOHN",
"crosscheck_score": 1.0,
"cross_checkable": true
},
"lastname": {
"value": "DOE",
"crosscheck_score": 0.95,
"cross_checkable": true
},
"birth_date": {
"value": "1986-01-06",
"crosscheck_score": 1.0,
"cross_checkable": true
},
"document_number": {
"value": "111111111",
"crosscheck_score": 1.0,
"cross_checkable": true
},
"document_country": {
"value": "USA",
"crosscheck_score": 0.0,
"cross_checkable": false
},
"document_type": {
"value": "PASSPORT",
"crosscheck_score": 0.0,
"cross_checkable": false
},
"expiration_date": {
"value": "2027-03-22",
"crosscheck_score": 1.0,
"cross_checkable": true
},
"nationality": {
"value": "USA",
"crosscheck_score": 0.0,
"cross_checkable": false
}
},
"valid": true,
"authenticity_score": 0.996,
"features": {
"security": [
{
"name": "Signature",
"confidence_score": 0.999,
"included": true
},
{
"name": "Face",
"confidence_score": 0.999,
"included": true
},
{
"name": "Second Birth Date",
"confidence_score": 0.999,
"included": true
},
{
"name": "Passport Header",
"confidence_score": 0.999,
"included": true
}
],
"data": [
{
"name": "Document Type",
"confidence_score": 0.995,
"included": true
},
{
"name": "Document Country",
"confidence_score": 0.997,
"included": true
},
{
"name": "Firstname",
"confidence_score": 0.996,
"included": true
},
{
"name": "Gender",
"confidence_score": 0.999,
"included": true
},
{
"name": "Identity Number",
"confidence_score": 0.997,
"included": true
},
{
"name": "Expiration Date",
"confidence_score": 0.999,
"included": true
},
{
"name": "Issuing Date",
"confidence_score": 0.998,
"included": true
},
{
"name": "Birth Date",
"confidence_score": 0.999,
"included": true
},
{
"name": "Lastname",
"confidence_score": 0.999,
"included": true
},
{
"name": "Nationality",
"confidence_score": 0.999,
"included": true
},
{
"name": "Height",
"confidence_score": 0.999,
"included": true
},
{
"name": "Birth Place",
"confidence_score": 0.998,
"included": true
},
{
"name": "Document Number",
"confidence_score": 0.999,
"included": true
},
{
"name": "Authority",
"confidence_score": 0.999,
"included": true
}
],
"mrz": [
{
"name": "MRZ",
"confidence_score": 0.999,
"included": true,
"verified": true
}
]
},
"notices": []
},
"certificate_link": "https://synaps-ai-certificates.synaps.io",
"session_id": "iSF0Xh-Si3ZV1-9CevQe-eUdgjX"
}

API Response

Field

Type

Description

verification

VerificationObject

Complete verification structure

session_id

string

Session ID of the identity verification

The download link will give you a PDF file which is a certificate of a completed identity verification.

VerificationObject

Field

Type

Description

info

InfoObject

Person identity information

valid

boolean

true if there is no inconsistency,

missing information or expiration

authenticity_score

number

overall score of the processed verification

based on our AI confidence score and cross

checking score when any

features

FeaturesArray

list of security features, data and MRZ that

must be on the document to be genuine

notices

NoticesArray

list of elements noticed when performing

the identity verification (such as expiration date,

data inconsistency, missing security feature)

InfoObject Standard information of a processed identity verification

Field

Type

Description

firstname

IdentityInfoObject

Legal firstname

lastname

IdentityInfoObject

Legal lastname

birth_date

IdentityInfoObject

Birth Date (Format YYYY-MM-DD)

document_number

IdentityInfoObject

Document number

document_country

IdentityInfoObject

Document country (ISO-3166 format)

document_type

IdentityInfoObject

Document Type (PASSPORT, NATIONAL_ID, DRIVER_LICENSE)

expiration_date

IdentityInfoObject

Expiration Date (Format YYYY-MM-DD)

nationality

IdentityInfoObject

Nationality country (ISO-3166 format) - Empty if document_type is a Driver License

IdentityInfoObject Value of extracted information

Field

Type

Description

value

string

Value of the field

crosscheck_score

number

Cross-check score (if there is a MRZ, a cross-checking will be processed against OCR value)

cross_checkable

boolean

true if there is multiple source of extraction (OCR + MRZ)

false if there is only one source of extraction (OCR)

if cross_checkable is false, crosscheck_score is equal to 0.00

FeaturesArray Array of features

Field

Type

Description

security

SecurityFeaturesArray

list of all security features included in the document

data

DocumentDataArray

list of all document data included in the document

mrz

MrzArray

list of all MRZ (Machine Readable Zone) included

on the document

SecurityFeaturesArray Array of document security features

Field

Type

Description

value

string

Name of the security feature

confidence_score

number

Percentage (0 to 1) of our AI confidence score

included

boolean

true if the feature is included on the document

false if the feature is missing

DocumentDataArray Array of document data features

Field

Type

Description

value

string

Name of the document data field

confidence_score

number

Percentage (0 to 1) of our AI confidence score

included

boolean

true if the feature is included on the document

false if the feature is missing

MrzArray Array of document MRZ (Machine Readable Zone)

Field

Type

Description

value

string

Name of the Machine Readable Zone

confidence_score

number

Percentage (0 to 1) of our AI confidence score

included

boolean

true if the feature is included on the document

false if the feature is missing

verified

boolean

true if the MRZ algorithm has been verified

false if the MRZ algorithm is inconsistent

NoticesArray Array of inconsistent, missing or expired elements

Field

Type

Description

name

string

Name of the element involved

type

number

There is for 4 types of notices: INCONSISTENT : inconsistent data between document (OCR) and MRZ

MISSING : missing element

EXPIRED : expired document UNVERIFIED : element is not verified

get
Download Session Certificate

https://auto-id-api.synaps.io/v1/session/certificate
Return a PDF certificate with all the verification details for a given session ID.
Request
Response
Request
Headers
Authorization
required
string
App API Key
Query Parameters
session_id
required
string
a valid session_id previously created must be provided
Form Data Parameters
lang
optional
string
Available only in english (en)
Response
200: OK
<binary file>

A PDF binary file will be returned, you should store the bytes received on your filesystem.