Face Authentication Webhook

This webhook is specifically designed for use with the Face Authentication module. It also requires the webhooks to be defined in the Configuration > Webhooks tab in Dashboard.

Success Notification

The following code block shows an example of a payload for a successful attempt when the Face Authentication module is used.

{
    "interviewId": <string>,
    "customerId": <string>,
    "externalCustomerId": <string>,
    "overallStatus": <string> ("PASS" | "FAIL"),
    "hint": <string>,
    "attemptCounterState": {
        "max": <int>,
        "remaining": <int>
    },
    "error": {
        "name": <string> (check possible codes below),
        "message": <string>
    }
}

Failure Notifications

Possible errors include:

• "INACTIVE_SESSION"
• "HINT_NOT_PROVIDED"
• "NONEXISTENT_CUSTOMER"
• "MULTIPLE_FACES_DETECTED"
• "SPOOF_ATTEMPT_DETECTED"
• "FACE_TOO_DARK"
• "FACE_CROPPING_FAILED"
• "FACE_TOO_SMALL"
• "FACE_TOO_BLURRY"
• "BAD_PHOTO_QUALITY"
• "LENSES_DETECTED"
• "FACE_MASK_DETECTED"
• "HEAD_COVER_DETECTED"
• "CLOSED_EYES_DETECTED"
• "SELFIE_FACE_OCCLUDED"
• "SELFIE_IMAGE_LOW_QUALITY"
• "USER_IS_NOT_RECOGNIZED"
• "FACE_NOT_FOUND"
• "BAD_REQUEST"
• "PROCESSING_ERROR"
• "DEFAULT_ERROR"

The following code block shows an example of a payload for a failed attempt when the Face Authentication module is used. This payload includes two fields with information about the error: its name and message.

{
  "interviewId": "68e6492f71ccd116c458f59a",
  "customerId": "68e4e62e44106b8c9535436e",
  "overallStatus": "FAIL",
  "hint": "68e4e62e44106b8c9535436e",
  "error": {
      "name": "SPOOF_ATTEMPT_DETECTED",
      "message": "Spoof attempt detected"
   }
}