ID Document

Submit Identity document

POST https://individual-api.synaps.io/v3/identity/submit

Send an identity document to verification

Query Parameters

Name	Type	Description
step_id	string	Step Id of the current identity step you want to submit

Name

Type

Description

step_id

string

Step Id of the current identity step you want to submit

Headers

Name	Type	Description
Session-Id	string	Initialised Session-Id

Name

Type

Description

Session-Id

string

Initialised Session-Id

Request Body

Name Type Description

Name	Type	Description
back_document	object	must be a valid file (image/jpg, image/jpeg, image/png) max 4MB
front_document	object	must be a valid file (image/jpg, image/jpeg, image/png) max 4MB
document_type	string	Type of document `PASSPORT` `NATIONAL_ID` `DRIVER_LICENSE` `RESIDENT_PERMIT`
country	string	Country of document in alpha 3 code (ISO-3166) (e.g. for France send FRA as country value)

back_document

object

must be a valid file (image/jpg, image/jpeg, image/png) max 4MB

front_document

object

must be a valid file (image/jpg, image/jpeg, image/png) max 4MB

document_type

string

Type of document PASSPORT NATIONAL_ID DRIVER_LICENSE RESIDENT_PERMIT

country

string

Country of document in alpha 3 code (ISO-3166) (e.g. for France send FRA as country value)

{
    "document": {
        "document": {
            "country": "FRA",
            "type": "NATIONAL_ID",
            "front_file": "<signed_url>",
            "back_file": "<signed_url>"
        },
        "state": "VALIDATED",
        "lang": "en",
        "details": {
            "info": {
                "firstname": {
                    "name": "firstname",
                    "document_side": "FRONT",
                    "slug": "firstname",
                    "cross_checkable": true,
                    "cross_checked": true,
                    "value": "JOHN"
                },
                "lastname": {
                    "name": "lastname",
                    "document_side": "FRONT",
                    "slug": "lastname",
                    "cross_checkable": true,
                    "cross_checked": true,
                    "value": "DOE"
                },
                "birth_date": {
                    "name": "birth date",
                    "document_side": "FRONT",
                    "slug": "birth_date",
                    "cross_checkable": true,
                    "cross_checked": true,
                    "value": "1990-01-03"
                },
                "document_expiration": {
                    "name": "document expiration",
                    "document_side": "BACK",
                    "slug": "document_expiration",
                    "cross_checkable": false,
                    "cross_checked": false,
                    "value": "2024-12-08"
                },
                "document_number": {
                    "name": "document Number",
                    "document_side": "FRONT",
                    "slug": "document_number",
                    "cross_checkable": true,
                    "cross_checked": true,
                    "value": "23I42991923"
                },
                "nationality": {
                    "name": "nationality",
                    "document_side": "FRONT",
                    "slug": "nationality",
                    "cross_checkable": false,
                    "cross_checked": false,
                    "value": "FRA"
                }
            },
            "features": {
                "security": [
                    {
                        "name": "header",
                        "slug": "header",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "watermark",
                        "slug": "watermark",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "name initials",
                        "slug": "name_initials",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "header",
                        "slug": "header",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "watermark",
                        "slug": "watermark",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "name initials",
                        "slug": "name_initials",
                        "document_side": "FRONT",
                        "included": true
                    }
                ],
                "fields": [
                    {
                        "name": "gender",
                        "slug": "gender",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "height",
                        "slug": "height",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "birth place",
                        "slug": "birth_place",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "signature",
                        "slug": "signature",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "issuing date",
                        "slug": "issuing_date",
                        "document_side": "BACK",
                        "included": true
                    },
                    {
                        "name": "authority",
                        "slug": "authority",
                        "document_side": "BACK",
                        "included": true
                    },
                    {
                        "name": "authority signature",
                        "slug": "authority_signature",
                        "document_side": "BACK",
                        "included": true
                    },
                    {
                        "name": "address",
                        "slug": "address",
                        "document_side": "BACK",
                        "included": true
                    }
                ]
            },
            "mrz": {
                "barcode": {
                    "name": "barcode",
                    "document_side": "",
                    "slug": "mrz_barcode",
                    "valid": false
                },
                "lines": {
                    "name": "Lines",
                    "document_side": "FRONT",
                    "slug": "mrz_lines",
                    "valid": true
                }
            }
        }
    },
    "duplicate": {
        "state": "VALIDATED"
    },
    "facematch": {
        "state": "VALIDATED"
    },
    "history": [
        {
            "user_reason": "",
            "customer_reason": "",
            "rejection_code": "",
            "submitted_at": "2021-07-27 13:31:22",
            "verified_at": "2021-07-27 13:54:54",
            "state": "VALIDATED"
        }
    ],
    "state": "VALIDATED"
}

Get identity verification details

GET https://individual-api.synaps.io/v3/identity/details

All information about identity verification details

Query Parameters

Name	Type	Description
step_id	string	step_id of the phone verification step

Name

Type

Description

step_id

string

step_id of the phone verification step

Headers

Name	Type	Description
Session-Id	string	Synaps Session-Id
Api-Key	string	Synaps Api-Key
Client-Id	string	Synaps Client-Id

Name

Type

Description

Session-Id

string

Synaps Session-Id

Api-Key

string

Synaps Api-Key

Client-Id

string

Synaps Client-Id

{
    "document": {
        "document": {
            "country": "FRA",
            "type": "NATIONAL_ID",
            "front_file": "<signed_url>",
            "back_file": "<signed_url>"
        },
        "state": "VALIDATED",
        "lang": "en",
        "details": {
            "info": {
                "firstname": {
                    "name": "firstname",
                    "document_side": "FRONT",
                    "slug": "firstname",
                    "cross_checkable": true,
                    "cross_checked": true,
                    "value": "JOHN"
                },
                "lastname": {
                    "name": "lastname",
                    "document_side": "FRONT",
                    "slug": "lastname",
                    "cross_checkable": true,
                    "cross_checked": true,
                    "value": "DOE"
                },
                "birth_date": {
                    "name": "birth date",
                    "document_side": "FRONT",
                    "slug": "birth_date",
                    "cross_checkable": true,
                    "cross_checked": true,
                    "value": "1990-01-03"
                },
                "document_expiration": {
                    "name": "document expiration",
                    "document_side": "BACK",
                    "slug": "document_expiration",
                    "cross_checkable": false,
                    "cross_checked": false,
                    "value": "2024-12-08"
                },
                "document_number": {
                    "name": "document Number",
                    "document_side": "FRONT",
                    "slug": "document_number",
                    "cross_checkable": true,
                    "cross_checked": true,
                    "value": "23I42991923"
                },
                "nationality": {
                    "name": "nationality",
                    "document_side": "FRONT",
                    "slug": "nationality",
                    "cross_checkable": false,
                    "cross_checked": false,
                    "value": "FRA"
                }
            },
            "features": {
                "security": [
                    {
                        "name": "header",
                        "slug": "header",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "watermark",
                        "slug": "watermark",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "name initials",
                        "slug": "name_initials",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "header",
                        "slug": "header",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "watermark",
                        "slug": "watermark",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "name initials",
                        "slug": "name_initials",
                        "document_side": "FRONT",
                        "included": true
                    }
                ],
                "fields": [
                    {
                        "name": "gender",
                        "slug": "gender",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "height",
                        "slug": "height",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "birth place",
                        "slug": "birth_place",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "signature",
                        "slug": "signature",
                        "document_side": "FRONT",
                        "included": true
                    },
                    {
                        "name": "issuing date",
                        "slug": "issuing_date",
                        "document_side": "BACK",
                        "included": true
                    },
                    {
                        "name": "authority",
                        "slug": "authority",
                        "document_side": "BACK",
                        "included": true
                    },
                    {
                        "name": "authority signature",
                        "slug": "authority_signature",
                        "document_side": "BACK",
                        "included": true
                    },
                    {
                        "name": "address",
                        "slug": "address",
                        "document_side": "BACK",
                        "included": true
                    }
                ]
            },
            "mrz": {
                "lines": {
                    "name": "Lines",
                    "document_side": "FRONT",
                    "slug": "mrz_lines",
                    "valid": true
                }
            }
        }
    },
    "duplicate": {
        "state": "VALIDATED"
    },
    "facematch": {
        "state": "VALIDATED"
    },
    "history": [
        {
            "user_reason": "",
            "customer_reason": "",
            "rejection_code": "",
            "submitted_at": "2021-07-27 13:31:22",
            "verified_at": "2021-07-27 13:54:54",
            "state": "VALIDATED"
        }
    ],
    "state": "VALIDATED"
}

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

REJECTED

`IdentityDuplicate | Object`

Field

Type

Description

state

string

Verification state

VALIDATED

NOT_STARTED

PENDING

REJECTED

session_id

string

Optional in case the session has not been flagged as duplicate. Approved session that has match with the current session

alias

string

Optional in case the session has not been flagged as duplicate Approved session alias that has match with the current session

`IdentityFacematch | Object`

Field

Type

Description

state

string

Verification state

VALIDATED

NOT_STARTED

PENDING

REJECTED

`IdentityVerificationDocument | Object`

Field

Type

Description

document

IdentityDocument | Object

Document metadata

state

string

Verification state

VALIDATED

NOT_STARTED

PENDING

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

"features": {
        "security": [
            {
                "name": "header",
                "slug": "header",
                "document_side": "FRONT",
                "included": true
            },
            {
                "name": "watermark",
                "slug": "watermark",
                "document_side": "FRONT",
                "included": true
            },
            {
                "name": "name initials",
                "slug": "name_initials",
                "document_side": "FRONT",
                "included": true
            },
        ],
        "fields": [
            {
                "name": "gender",
                "slug": "gender",
                "document_side": "FRONT",
                "included": true
            },
            {
                "name": "height",
                "slug": "height",
                "document_side": "FRONT",
                "included": true
            },
            {
                "name": "birth place",
                "slug": "birth_place",
                "document_side": "FRONT",
                "included": true
            },
        ]
    }

`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

"mrz": {
    "lines": {
        "name": "Lines",
        "document_side": "FRONT",
        "slug": "mrz_lines",
        "valid": true
    }
}

PreviousSteps NextProof of Residency

Last updated 1 year ago