Liveness

Init Liveness

POST https://individual-api.synaps.io/v3/liveness/init

Verify if the person in front of his camera is alive

Query Parameters

Name	Type	Description
step_id	string	Step ID of the current liveness step you want to submit

Headers

Name	Type	Description
Session-Id	string	Initialized Session-Id

200

API Response

Field	Type	Description
token	string	LIveness challenge unique token

Verify Liveness

POST https://individual-api.synaps.io/v3/liveness/verify

Verify if the person in front of his camera is alive

Query Parameters

Name	Type	Description
step_id	string	Step ID of the current liveness step you want to submit

Headers

Name	Type	Description
Session-Id	string	Initialized Session-Id

200

API Response

Field	Type	Description
success	bool	true if challenge is passed false if challenge is failed
reason	string	empty if success is true Failure reason challenge failed

Get liveness verification details

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

All information about liveness verification details

Query Parameters

Name	Type	Description
step_id	string	step_id of the liveness verification step

Headers

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

200

{
    "verification": {
        "phone_country": "33",
        "phone_number": "0683928392",
        "carrier": {
            "type": "mobile",
            "name": "SOCIETE FRANCAISE DU RADIOTELEPHONE (SFR)"
        },
        "attempts": [
            {
                "method": "sms",
                "time": 1627393493143
            }
        ],
        "state": "VALIDATED"
    },
    "type": "PHONE"
}

API Response

LivenessVerificationResponse | Object

Field	Type	Description
attempts	number	number of liveness attempts
enrollment_date	string	Successful enrollment date Datetime format : YYYY-MM-DD hh:ii:ss
face	string	image of the user's face available through a signed URL (15 minutes expiry)
state	string	Verification state VALIDATED NOT_STARTED PENDING REJECTED