CLOVA eKYC Webhook

신분증(주민등록증, 운전면허증, 여권, 외국인등록증)의 진위 검증 사이트별 장애 등을 웹훅으로 제공합니다. eKYC 도메인의 고급 설정에서 웹훅 URL을 설정할 수 있습니다.

Webhook payloads

eKYC 서비스에서 전송하는 웹훅 형식은 다음과 같습니다.

메서드	URL
POST	도메인에 설정한 웹훅 URL

`Content-Type: application/json`

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`inferType`	String	Required	`ID_CARD` (현재는 신분증만 제공)
`inferDetailType`	String	Required	검증 상세 유형 `IC` \| `DL` \| `PP` \| `AC` `IC`: 주민등록증 `DL`: 운전면허증 `PP`: 여권 `AC`: 외국인등록증
`site`	String	Required	진위 검증 사이트 - 주민등록증: 정부24 - 운전면허증: 안전운전면허, 경찰청 - 여권: 정부24 - 외국인등록증: 하이코리아
`verifyStatus`	String	Required	검증 상태 `GREEN` \| `YELLOW` \| `RED` `GREEN`: 정상 `YELLOW`: 처리 지연 등 `RED`: 사이트 오류
`description`	String	Required	안내 사항
`fromTime`	String	Required	이벤트 시작 시간 (yyyyMMddHHmm)
`toTime`	String	Optional	이벤트 종료 시간 (yyyyMMddHHmm) 사이트에서 장애 혹은 점검 시간이 고지되는 경우

Payloads 예시

Payloads 예시는 다음과 같습니다.

{
    "inferType": "ID_CARD",
    "inferDetailType": "IC",
    "site": "정부24",
    "verifyStatus": "RED",
    "description": "현재 진위검증 사이트 오류로 진위검증 서비스를 이용할 수 없습니다.",
    "fromTime": "202207211800"
}