• 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 type is “faceAuth”.
faceauth-webhook-sample.json
{
    "webhook_trigger": "faceAuth",
    "auth_id": "string",
    "data": {
      "submission_id": "string",
      "auth_status": "string",
      "create_time": "string",
      "user_id": "string",
      "cf1": "string",
      "cf2": "string",
      "cf3": "string"
    }
}
​
webhook_trigger
string

Webhook trigger type - submit indicates a pending status after submission.

​
auth_id
string

Unique ID for each FaceAuth submission.

​
data
object

Webhook payload data.