Verify Document

post
Process Automatic Document Verification
https://autoid-api.synaps.io/v1/document/verify
Return a full breakdown of the identity verification breakdown on a given ID
Request
Response
Request
Headers
Session-Id
required
string
a valid Session-Id previously initialized must be provided
Query Parameters
callback_url
optional
string
Callback URL when you want non-blocking request
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"
}
Non-Blocking Request
If you want a non-blocking request, you can schedule a document verification and get called back with your callback_url. It will allows you to get your response back later on. To schedule a request and get called back, simply add callback_url as a query parameters. We will fire an event to the URL when the document processing is finished. 
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, RESIDENT_PERMIT)
document_expiration
IdentityInfoObject
Document 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

Auto ID - Previous

Supported Documents

Next - Auto ID

Details

Last updated 4 months ago

Field	`Type`	Description
verification	`VerificationObject`	Complete verification structure
session_id	`string`	Session ID of the identity verification

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)

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, RESIDENT_PERMIT`)
document_expiration	`IdentityInfoObject`	Document Expiration Date (Format `YYYY-MM-DD`)
nationality	`IdentityInfoObject`	Nationality country (ISO-3166 format) - Empty if document_type is a Driver License

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`

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

Verify Document

post
Process Automatic Document Verification

Non-Blocking Request

API Response

`VerificationObject`

`InfoObject` Standard information of a processed identity verification

`IdentityInfoObject` Value of extracted information

`FeaturesArray` Array of features

`SecurityFeaturesArray` Array of document security features

`DocumentDataArray` Array of document data features

`MrzArray` Array of document MRZ (Machine Readable Zone)

`NoticesArray` Array of inconsistent, missing or expired elements

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

Verify Document

postProcess Automatic Document Verification

Non-Blocking Request

API Response

VerificationObject

InfoObject Standard information of a processed identity verification

IdentityInfoObject Value of extracted information

FeaturesArray Array of features

SecurityFeaturesArray Array of document security features

DocumentDataArray Array of document data features

MrzArray Array of document MRZ (Machine Readable Zone)

NoticesArray Array of inconsistent, missing or expired elements

post
Process Automatic Document Verification

`VerificationObject`

`InfoObject` Standard information of a processed identity verification

`IdentityInfoObject` Value of extracted information

`FeaturesArray` Array of features

`SecurityFeaturesArray` Array of document security features

`DocumentDataArray` Array of document data features

`MrzArray` Array of document MRZ (Machine Readable Zone)

`NoticesArray` Array of inconsistent, missing or expired elements