Synaps
Search…
ID Document
post
https://individual-api.synaps.io
/v3/identity/submit
Submit Identity document
get
https://individual-api.synaps.io
/v3/identity/details
Get identity verification details
API Response

IdentityVerificationResponse | Object

Field
Type
Description
document
IdentityVerificationDocument | Object
ID document details
duplicate
IdentityDuplicate | Object
Uniqueness check
facematch
IdentityFacematch | Object
User facematch with liveness
history
IdentityHistory | Array
Verification history
state
string
Verification state
VALIDATED
NOT_STARTED
PENDING
FINAL_REJECTED

IdentityDuplicate | Object

Field
Type
Descriptio
state
string
Verification state
VALIDATED
NOT_STARTED
PENDING
FINAL_REJECTED

IdentityFacematch | Object

Field
Type
Descriptio
state
string
Verification state
VALIDATED
NOT_STARTED
PENDING
FINAL_REJECTED

IdentityVerificationDocument | Object

Field
Type
Description
document
IdentityDocument | Object
Document metadata
state
string
Verification state
VALIDATED
NOT_STARTED
PENDING
FINAL_REJECTED
details
IdentityDocumentDetails | Object
ID Document details

IdentityDocument | Object

Field
Type
Description
type
string
Document type
NATIONAL_ID PASSPORT DRIVER_LICENSE RESIDENT_PERMIT
country
string
Issuing country (see country code ISO-3166)
front_file
string
image of the front document available through a signed URL (15 minutes expiry)
back_file
string
image of the back document available through a signed URL (15 minutes expiry)

IdentityDocumentDetails | Object

Field
Type
Description
info
IdentityDocumentInfo | Object
User info
features
IdentityDocumentFeatures | Array
Document features
mrz
IdentityDocumentMrz | Object
Document MRZ

IdentityDocumentInfo | Object

Field
type
Description
key
string
firstname, lastname, birth_date, document_expiration, document_number
value
IdentityInfo
value of identity info

IdentityInfo | Object

Field
type
Description
name
string
name of the field
document_side
string
document side where the info is FRONT / BACK
slug
string
unique info identifier
cross_checkable
boolean
crosscheckable if there is a MRZ with a value to crosscheck
cross_checked
boolean
crosschecked with MRZ if any
value
string
value of the info

IdentityDocumentFeatures | Array

Field
type
Description
security
IdentityFeatures | Array
list of security features
fields
IdentityFeatures | Array
list of document fields

IdentityFeatures | Object

Field
type
Description
name
string
name of the feature
slug
string
feature unique identifier
document_side
string
document side where the feature is FRONT / BACK
included
boolean
If the feature is included
1
"features": {
2
"security": [
3
{
4
"name": "header",
5
"slug": "header",
6
"document_side": "FRONT",
7
"included": true
8
},
9
{
10
"name": "watermark",
11
"slug": "watermark",
12
"document_side": "FRONT",
13
"included": true
14
},
15
{
16
"name": "name initials",
17
"slug": "name_initials",
18
"document_side": "FRONT",
19
"included": true
20
},
21
],
22
"fields": [
23
{
24
"name": "gender",
25
"slug": "gender",
26
"document_side": "FRONT",
27
"included": true
28
},
29
{
30
"name": "height",
31
"slug": "height",
32
"document_side": "FRONT",
33
"included": true
34
},
35
{
36
"name": "birth place",
37
"slug": "birth_place",
38
"document_side": "FRONT",
39
"included": true
40
},
41
]
42
}
Copied!

IdentityDocumentMrz | Object

Field
type
Description
lines
IdentityMrz
Lines MRZ
barcode
IdentityMrz
Barcode MRZ

IdentityMrz | Object

Field
type
Description
name
string
Name of the MRZ field
document_side
string
document side where the feature is FRONT / BACK
slug
string
unique identifier
valid
boolean
true if MRZ algorithm is verified
false if MRZ algorithm is not verified
1
"mrz": {
2
"lines": {
3
"name": "Lines",
4
"document_side": "FRONT",
5
"slug": "mrz_lines",
6
"valid": true
7
}
8
}
Copied!
Last modified 1mo ago