Skip to main content
  • 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
faceAuth is compared with approved submissions from previously submitted ID checks
  • target: Parameters used in the QueryString when making a Faceauth request
  • reference: Previously submitted ID check submission that serves as the comparison target for faceAuth
string
Webhook trigger type - faceAuth indicates this is a faceAuth webhook
string
Unique ID for each faceAuth submission [authId]
object
Webhook payload data