> ## 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 결과 웹훅

> faceAuth 인증이 완료된 후 최종 결과(approved 또는 rejected)를 기존 ID Check 프로젝트의 Webhook URL로 자동 전송하여 실시간 알림을 제공합니다.

<Note>
  * AddOn faceAuth가 제출되고 최종 결과(auth\_status)가 도출되었을 때 Webhook이 발송됩니다.
  * Webhook은 기존 ID Check 프로젝트에 등록된 Webhook URL로 전송됩니다. 웹훅 등록 방법은 [여기서](/ko/idcheck/webhooks/overview#2-register-webhook-events) 확인해주세요.
  * Webhook의 트리거는 "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는 이전에 제출된 ID check의 승인된 제출건과 비교됩니다

  * `target` : Faceauth 요청시 QueryStirng에 사용된 파라미터
  * `reference` : faceAuth 비교의 대상이 되는 이전에 제출된 ID check의 submission
</Info>

<ResponseField name="webhook_trigger" type="string">
  Webhook trigger type - `faceAuth` faceAuth webhook임을 알림
</ResponseField>

<ResponseField name="Authentication_id" type="string">
  각 faceAuth 제출 건에 대한 고유 ID \[authId]
</ResponseField>

<ResponseField name="data" type="object">
  Webhook 본문 데이터

  <Expandable title="properties">
    <ResponseField name="Submission_id" type="string">
      faceAuth 비교의 대상이 되는 특정 제출 건의 고유 ID
    </ResponseField>

    <ResponseField name="Auth_Status" type="string">
      faceAuth 최종 결과를 나타냅니다. approved(성공) 또는 rejected(실패)를 반환합니다
    </ResponseField>

    <ResponseField name="Create_Time" type="string">
      faceAuth에 제출된 날짜와 시간 (UTC+0)
    </ResponseField>

    <ResponseField name="Auth_User_id" type="string">
      target Submission\_id의 제출 생성 시 선택적으로 추가된 user\_id 파라미터

      * FaceAuth URL 파라미터에선 authUserId로 사용
    </ResponseField>

    <ResponseField name="Auth_cf1" type="string">
      target의 사용자 정의 필드 #1

      * FaceAuth URL 파라미터에선 authCf1로 사용
    </ResponseField>

    <ResponseField name="Auth_cf2" type="string">
      target의 사용자 정의 필드 #2

      * FaceAuth URL 파라미터에선 authCf2로 사용
    </ResponseField>

    <ResponseField name="Auth_cf3" type="string">
      target의 사용자 정의 필드 #3

      * FaceAuth URL 파라미터에선 authCf3로 사용
    </ResponseField>

    <ResponseField name="Token_id" type="string">
      target에서 사용한 Token Id

      * FaceAuth URL 파라미터에선 token으로 사용
    </ResponseField>

    <ResponseField name="reference" type="object">
      faceAuth 비교의 대상이 되는 reference submission

      <Expandable title="properties">
        <ResponseField name="userid" type="string">
          faceAuth 비교의 대상이 되는 reference Submission\_id의 userid
        </ResponseField>

        <ResponseField name="email" type="string">
          faceAuth 비교의 대상이 되는 reference Submission\_id의 email
        </ResponseField>

        <ResponseField name="cf" type="object">
          faceAuth 비교의 대상이 되는 reference Submission\_id의 사용자 정의 필드들

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

            <ResponseField name="cf2" type="string">
              reference의 cf2
            </ResponseField>

            <ResponseField name="cf3" type="object">
              reference의 cf3
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>
