# Webhook

On your settings page, you may set a webhook URL that we will invoke when an ID Check is completed. An HTTP POST will be sent with a JSON body containing the Check ID and completion status. For example, if the webhook URL you provided is https://www.myverifiedapp.com/my_webhook, a HTTP POST will be sent to the URL with check_id and status as JSON fields in the body:

{
    "check_id": "chk_priv_sDhhdFghuIbfdxaZ",
    "status": "COMPLETED"
}

The status parameter will be one of the following values:

  • "COMPLETED": The ID Check was completed successfully.
  • "EXPIRED": The ID Check expired.
  • "FAILED": The ID Check failed due to invalid input (e.g. unsupported document). Failed ID Checks cannot be modified, so a new ID Check should be sent to this user.
  • "INTERNAL_ERROR": There was a problem performing the ID Check. Failed ID Checks are not editable, so a new ID Check should be sent to this user.

# Webhook retry

If the call to the webhook you provided fails, we will retry to call your webhook every hour, up to three times.