Authentication Webhook 1:1

This webhook will only trigger during 1:1 Authentications. Notifications are delivered for both, successful and failed attempts.

Successful attempts

Successful attempts example payload

{
  "customerId": "67460a9995516d9a553aa95b",
  "token": "",
  "interviewId": "60000a22b09a35d2ef5aaa99",
  "interviewToken": "",
  "transactionId": "549994d9r3474bfcbbbdc5a5",
  "faceMatch": true,
  "spoofAttempt": false,
  "secondFactor": false,
  "children": [],
  "hasFaceMask": false,
  "hasLenses": false,
  "spoofConfidence": 0.0010233838,
  "recognitionConfidence": {
    "confidence": 0.93098663,
    "candidates": []
  },
  "overallScore": 0.93098663,
  "overallStatus": "PASS"

Failed attempts

There are 3 fields with information about the error:

error
errorCode
errorMessage

Their values vary depending on the error:

error	errorCode	errorMessage
User blacklisted	4003	NA
Non existing customer	4004	Can't find customer by any criteria
Spoof attempt detected	4005	Spoof attempt detected. Spoof confidence 1.0
User is not recognized	4015	NA

Failed attempts example payloads

{  
"customerId": "666eab5555888d45ba7a999a", 
"faceMatch": false, 
"children": [], 
"recognitionConfidence": {}, 
"overallScore": 0, 
"overallStatus": "FAIL",  
"error": "Non existing customer", 
"errorCode": 4004, 
"errorMessage": "Can't find customer by any criteria." 
}

{
  "customerId": "67dda40e4089f4769f3ed2e6",
  "transactionId": "e59ee5a064e24d129d1beed9",
  "faceMatch": false,
  "spoofAttempt": true,
  "children": [],
  "spoofConfidence": 1,
  "recognitionConfidence": {},
  "overallScore": 0,
  "overallStatus": "FAIL",
  "error": "Spoof attempt detected",
  "errorCode": 4005,
  "errorMessage": "Spoof attempt detected. Spoof confidence 1.0"
 }

{
  "customerId": "678057dbb632b29f45a280b5",
  "transactionId": "18e69943c68a4f5e89d61857",
  "faceMatch": false,
  "spoofAttempt": false,
  "children": [],
  "spoofConfidence": 0.00085131516,
  "recognitionConfidence": {},
  "overallScore": 0,
  "overallStatus": "FAIL",
  "error": "User is not recognized",
  "errorCode": 4015
}

{  
"customerId": "666eab5555888d45ba7a999a", 
"faceMatch": false, 
"children": [], 
"recognitionConfidence": {}, 
"overallScore": 0, 
"overallStatus": "FAIL",  
"error": "User blacklisted", 
"errorCode": 4003, 
}

{
  "customerId": "67dda40e4089f4769f3ed2e6",
  "transactionId": "0be5f261d076492d9d3b74f6",
  "faceMatch": false,
  "spoofAttempt": false,
  "hasFaceMask": false,
  "hasLenses": true,
  "recognitionConfidence": {
    "confidence": 0,
    "candidates": []
  },
  "overallScore": 0,
  "overallStatus": "FAIL"
}

{
  "customerId": "67dda40e4089f4769f3ed2e6",
  "transactionId": "0be5f261d076492d9d3b74f6",
  "faceMatch": false,
  "spoofAttempt": false,
  "hasFaceMask": true,
  "hasLenses": false,
  "recognitionConfidence": {
    "confidence": 0,
    "candidates": []
  },
  "overallScore": 0,
  "overallStatus": "FAIL"
}

📘
Failed attempts as a result of the user wearing lenses, mask or hat wear, are not consider errors, so no additional ‘error’ fields are sent within the notification.

🚧
A notification will also be sent in case of any Incode API exception (unpredicted error). For these cases we don’t have the exact values but all three new fields: errorCode, error and errorMessage will be added to payload

Updated 6 days ago