• A Webhook is triggered when the AddOn faceAuth is submitted and the final result (auth_status) is determined.
  • The Webhook is sent to the Webhook URL registered in the existing ID Check project. To register a Webhook, refer to this guide.
  • The Webhook trigger is “faceAuth”.
faceauth-webhook-sample.json
{
  "webhook_trigger": "faceAuth", 
  "Authentication_id": "{String}",
  "data": {
    "Submission_id": "{String}",
    "Auth_Status": "{String}",
    "Create_Time": "{String}",
    "User_id": "{String}",
    "cf1": "{String}",
    "cf2": "{String}",
    "cf3": "{String}",
    "reference": {
      "userid": "{String}",
      "email": "{String}",
      "cf": {
        "cf1": "{String}",
        "cf2": "{String}",
        "cf3": "{String}"
      }
    }
  }
}
faceAuth is compared with approved submissions from previously submitted ID checks
  • target: Parameters used in the POST /Faceauth request
  • reference: Previously submitted ID check submission that serves as the comparison target for faceAuth
​
webhook_trigger
string
Webhook trigger type - faceAuth indicates this is a faceAuth webhook
​
Authentication_id
string
Unique ID for each faceAuth submission
​
data
object
Webhook payload data