Details

get
Liveness details

https://liveness-api.synaps.io/v2/liveness/details
Get associated Session-Id details
Request
Response
Request
Headers
Api-Key
required
string
Synaps application Api-Key
Session-Id
required
string
Initialized Session-Id
Response
200: OK

API Response

Field

Type

Description

valid

boolean

Liveness challenge validity

true - valid

false - invalid

session_id

string

Session ID of the liveness

state

string

PENDING - Liveness in review

VALIDATED - Liveness valid

REJECTED - Liveness rejected

NOT_STARTED - Liveness not yet submitted

probability

number

Score between 0 and 1 to determine the probability of liveness the person (higher is better)

file

string

Synaps Signed Link of the Liveness Face (expires 15min after request)