Face Liveness

Passive liveness detection enhances security for person and/or document authentication solutions. It adds detection and alerting capabilities when a printed photo or digital image or a screenshot from monitor/TV is presented for identity authentication or physical access control workflows.

API call

To perform a face liveness check.

This API currently supports basic authentication. All endpoints require an Authentication header in the following form:

Authorization: 'Basic ' + Base64.encode(username + ':' + password)

Send a HTTP POST request to:

  • /api/v1/face/liveness

The following parameters are used for requests and responses:

sessionIdrequestunique, short-lived code to be generated by the client to track specific sessions
faceImageBaserequestonboarded person photo, Base64 format or URL link to it
sessionIdresponseunique, short-lived code to be generated by the client to track specific sessions. Same as in request
scoreresponsescore of the сheck. Higher score means higher liveness level, default threshold is set to 0.8
hasErrorresponseboolean parameter - true - verification process ended up with some error; false - no errors
errorresponseerror message in case of hasError set to true, informing about type of error, for instance FACE_NOT_FOUND
  "sessionId": "bbbf9002-c3a2-4308-b103-d80b9f5a2b84"

Response - passive liveness passed
  "sessionId": "bbbf9002-c3a2-4308-b103-d80b9f5a2b84",
  "score": 0.9997104,
  "hasError": false

Response - passive liveness not passed:
"sessionId": "bbbf9002-c3a2-4308-b103-d80b9f5a2b84",
"score": 0.002324,
"hasError": false

Response - error
  "sessionId": "bbbf9002-c3a2-4308-b103-d80b9f5a2b84",
  "hasError": true,
  "error": "FACE_NOT_FOUND"

List of errors

FACE_NOT_FOUNDFailed to detect faceFace detector can’t find face on image. Face detection has probabilistic nature and may have errors. It also has some sensitivity level and very small faces may be ignored.