> ## Documentation Index
> Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Faceauth Result

> After faceAuth verification is completed, the final result (approved or rejected) is automatically sent to the Webhook URL registered in the existing ID Check project, providing real-time notifications.

<Note>
  * 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](/en/idcheck/webhooks/overview#2-register-webhook-events).
  * The Webhook trigger is "faceAuth".
</Note>

```json faceauth-webhook-sample.json theme={null}
{
  "webhook_trigger": "faceAuth", 
  "data": {
    "Submission_id": "{String}",
    "Auth_Status": "{String}",
    "Create_Time": "{String}",
    "Auth_User_id": "{String}",
    "Auth_cf1": "{String}",
    "Auth_cf2": "{String}",
    "Auth_cf3": "{String}",
    "Token_id" : "{String}",
    "reference": {
      "userid": "{String}",
      "email": "{String}",
      "cf": {
        "cf1": "{String}",
        "cf2": "{String}",
        "cf3": "{String}"
      }
    },
    "Authentication_id": "{String}"
  }
}
```

<Info>
  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
</Info>

<ResponseField name="webhook_trigger" type="string">
  Webhook trigger type - `faceAuth` indicates this is a faceAuth webhook
</ResponseField>

<ResponseField name="Authentication_id" type="string">
  Unique ID for each faceAuth submission \[authId]
</ResponseField>

<ResponseField name="data" type="object">
  Webhook payload data

  <Expandable title="properties">
    <ResponseField name="Submission_id" type="string">
      Unique ID of the specific submission that serves as the target for faceAuth comparison
    </ResponseField>

    <ResponseField name="Auth_Status" type="string">
      Indicates the final result of faceAuth. Returns approved (success) or rejected (failure)
    </ResponseField>

    <ResponseField name="Create_Time" type="string">
      Date and time when faceAuth was submitted (UTC+0)
    </ResponseField>

    <ResponseField name="Auth_User_id" type="string">
      User\_id parameter optionally added when creating the target Submission\_id

      * Used as authUserId in FaceAuth URL parameters
    </ResponseField>

    <ResponseField name="Auth_cf1" type="string">
      Custom field #1 of the target

      * Used as authCf1 in FaceAuth URL parameters
    </ResponseField>

    <ResponseField name="Auth_cf2" type="string">
      Custom field #2 of the target

      * Used as authCf2 in FaceAuth URL parameters
    </ResponseField>

    <ResponseField name="Auth_cf3" type="string">
      Custom field #3 of the target

      * Used as authCf3 in FaceAuth URL parameters
    </ResponseField>

    <ResponseField name="Token_id" type="string">
      Token Id used in the target

      * Used as token in FaceAuth URL parameters
    </ResponseField>

    <ResponseField name="reference" type="object">
      Reference submission that serves as the comparison target for faceAuth

      <Expandable title="properties">
        <ResponseField name="userid" type="string">
          Reference Submission\_id's userid that serves as the comparison target for faceAuth
        </ResponseField>

        <ResponseField name="email" type="string">
          Email of the reference Submission\_id that serves as the comparison target for faceAuth
        </ResponseField>

        <ResponseField name="cf" type="object">
          Custom fields of the reference Submission\_id that serves as the comparison target for faceAuth

          <Expandable title="properties">
            <ResponseField name="cf1" type="string">
              cf1 of the reference
            </ResponseField>

            <ResponseField name="cf2" type="string">
              cf2 of the reference
            </ResponseField>

            <ResponseField name="cf3" type="string">
              cf3 of the reference
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>
