API ReferenceChangelogFAQDashboard

Face authentication

📘

Info

Face authentication cannot be requested via API since it requires our Liveness module handled by the WebSDK and MobileSDK. To perform the check, follow the instructions provided in Prevent unauthorized applicant activities.

Get results

To get the face authentication results, use this method.

The following is a response example. See review.reviewResult.reviewAnswer:

{
  // applicant action id - that's what you should get from WebSDK or MobileSDK
  "id" : "5d9f76507edd7d8162bfcea8",
  "createdAt" : "2019-10-10 18:20:00",
  "applicantId" : "5d9f74a27edd7d813405fe07",
  "type" : "selfieAuth",
  "review": {
    "reviewResult" : {
      "reviewAnswer" : "GREEN"
    },
  },
  // checks performed: liveness and comparison with the relevant document
  // NOTE: if liveness check didn't pass, we won't perform a face match check
  "checks" : [ {
    "answer" : "GREEN",
    "checkType" : "FACE_LIVELINESS",
    "createdAt" : "2019-10-10 18:19:57",
    "livenessInfo": {
      "livenessData": {
        "images": [
          {
            "imageId": 1368276695
          },
          {
            "imageId": 1060469685
          },
          {
            "imageId": 2074791000
          },
          {
            "imageId": 810045545
          },
          {
            "imageId": 1328042852
          }
         ]
        },
        "livenessResult": {
          "answer": "GREEN"
          }
        }
  },
  {
    "answer" : "GREEN",
    "checkType" : "FACE_MATCH",
    "createdAt" : "2019-10-10 18:20:00",
    "faceMatchInfo" : {
      "answer" : "GREEN",
    }
  } ]
}