Authentication webhook 1:N

❗️

Warning

This method of Face Authentication is being deprecated in favor of an updated method that uses a Face Authentication module within Workflows and Flows. This change allows for a higher level of security and configurability when authenticating users.

Key dates:

• End of Support (EoS): October 1, 2026
• End of Life (EoL) / Retirement: April 1, 2027

We recommend completing your migration by January 1, 2027 to avoid any last-minute issues or service disruptions.

Documentation for the new method of Face Authentication can be found here:

• Overview
• Module configuration
• Face Authentication webhook

This webhook will only trigger during 1:N Authentications. It contains information about the login attempt, the identities which could match the face reported by the login, and the interview which best matches the biometric of the face used to login.

{
  "customerId": "<customerIdentityId>",
  "token": "", //jwt
  "interviewId": "", 
  "interviewToken": "", // jwt
  "transactionId": "c3448d3bc3a14721ab4cf23e", // Id which represents this login's Id
  "faceMatch": true, 
  "spoofAttempt": false,
  "secondFactor": false,
  "children": [],
  "spoofConfidence": 0.0018711557,
  "recognitionConfidence": {
    "confidence": 0.8929258,
    "candidates": [
      {
        "identityId": "65eb5ca1f430218bb4b5ebd5",
        "confidence": 0.8929258
      }
    ]
  },
  "overallScore": 0.8929258,
  "overallStatus": "PASS"
}