버전
| 날짜 | 변경사항 |
|---|---|
| 2022-07-21 | 최초 작성 |
개요
신분증(주민등록증, 운전면허증, 여권, 외국인등록증) 의 진위검증 사이트별 장애 등을 webhook 으로 제공합니다.
eKYC 도메인의 고급 설정에서 webhook url 을 설정할 수 있습니다.
Webhook payloads
| 메서드 | URL |
|---|---|
| POST | 도메인에 설정한 webhook url |
Content-Type : application/json
필드 상세 설명
| 필드이름 | 필수여부 | 데이터유형 | 설명 |
|---|---|---|---|
| inferType | Y | string | 현재는 신분증만 제공하고 있어서 값은 항상 'ID_CARD' |
| inferDetailType | Y | string | - 주민등록증: IC - 운전면허증: DL - 여권: PP - 외국인등록증: AC |
| site | Y | string | 진위검증 사이트 - 주민등록증: 정부24 - 운전면허증: 안전운전면허, 경찰청 - 여권: 정부24 - 외국인등록증: 하이코리아 |
| verifyStatus | Y | string | GREEN: 정상, YELLOW: 처리지연 등, RED: 사이트 오류 |
| description | Y | string | 안내사항 |
| fromTime | Y | string | 이벤트 시작시간 (yyyyMMddHHmm) |
| toTime | N | string | 이벤트 종료시간 (yyyyMMddHHmm), 사이트에서 장애 혹은 점검시간이 고지되는 경우 |
Payloads 예시
{
"inferType": "ID_CARD",
"inferDetailType": "IC",
"site": "정부24",
"verifyStatus": "RED",
"description": "현재 진위검증 사이트 오류로 진위검증 서비스를 이용할 수 없습니다.",
"fromTime": "202207211800"
}