Biometrics Liveness

This endpoint exists only for the integration of the ZoOm's liveness engine. This integration should only take place using the provided BiometrID WebSDK.

Biometrics Liveness

POST https://face.biometrid.com/biometrics/liveness

This endpoint performs a liveness check on a given `zoomSessionData` object

Headers

Name	Type	Description
content-type	string	Accepts multipart/form-data ou application/json. Usage to be manage while implementing the solution
x-app-token	string	Liveness app token use to identify and validate the used account
x-user-agent	string	Liveness engine generated string that contains informations about the session and user agent

Request Body

Name	Type	Description
zoomSessionData	string	Proprietary data objects generated by the ZoOm Web library. This attribute should be a base64 string when using content-type: application/json and blob (application/zip) when using content-type: multipart/form-data
sessionId	string	The session id is output from the ZoOm iOS/Android/Web SDK's, is a unique string, and is used for traceability when following this transaction/facemap through processing.
auditTrail	array	Array of base64 encoded images, taken during the liveness video process

200 The The data object returned will include a livenessResult string with a value of "passed" or "undetermined".

{
  "meta": {
    "ok": true,
    "code": 200,
    "mode": "dev"
  },
  "data": {
    "livenessResult": "passed",
    "livenessScore": 86.91309364550425,
    "glassesScore": 8,
    "glassesDecision": false,
    "retryFeedbackSuggestion": 0,
    "message": "The facemap exhibited liveness"
  }
}

400 Request with invalid or missing attributes

{
    "meta": {
        "ok": false,
        "code": 400,
        "mode": "dev",
        "message": "You must pass a valid zoomSessionData or facemap parameter",
        "subCode": "missingParameter"
    }
}

401 Request with invalid x-app-token

{
    "meta": {
        "ok": false, 
        "code": 401,
        "mode": "dev",
        "message": "The X-App-Token header you provided did not validate",
        "subCode": "badAppToken"
    }
}

403 Response for requests without the x-app-token header

{
    "meta": {
        "ok": false,
        "code": 403,
        "mode": "dev",
        "message": "No X-App-Token header found",
        "subCode": "noAppToken"
    }
}