메인 콘텐츠로 건너뛰기

이벤트 유형

웹훅 페이로드는 프로세스 상태 전환을 설명합니다. 이 페이지에서는 페이로드 스키마와 lastEvent 값의 전체 목록을 문서화합니다.

페이로드 스키마​

필드유형설명
processIdstring (UUID)트랜잭션의 ID.
statestring트랜잭션의 현재 상태. 현재: PROCESS_STATE_FINISHED.
resultstring완료된 프로세스의 결과. state=PROCESS_STATE_FINISHED일 때 존재합니다. 가능한 값: ok, expired, invalid_identity.
flowstring해당 트랜잭션에 대해 실행된 플로우 (예: id, idtoken).
lastEventstring트랜잭션의 마지막 이벤트. result=expired인 경우에만 반환됩니다.
lastEventDescriptionstringlastEvent에 대한 사람이 읽을 수 있는 설명. result=expired인 경우에만 반환됩니다.
상태 용어

웹훅 페이로드의 state 필드는 PROCESS_STATE_* 접두사를 사용합니다. 이는 GetProcess 엔드포인트가 반환하는 result 및 status 필드(이 경우 PROCESS_RESULT_* 접두사 사용)와는 구별되는 용어입니다. 이 두 가지를 혼용하지 마세요.

페이로드 예시​

완료됨 — 성공​

{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "id",
  "result": "ok"
}

완료됨 — 만료됨​

{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "id",
  "result": "expired",
  "lastEvent": "EVENT_TYPE_SESSION_ENDED",
  "lastEventDescription": "Session ended by timeout or by new session created"
}

lastEvent 열거형​

lastEvent에 나타날 수 있는 값의 전체 목록:

이벤트설명
EVENT_TYPE_PROCESS_CREATED프로세스 생성됨
EVENT_TYPE_QR_CODE_READQR 코드가 읽혔음
EVENT_TYPE_PROCESS_STARTED_BY_USER사용자가 프로세스를 시작함
EVENT_TYPE_IDENTITY_VALIDATION_STEP_FINISHED신원 확인 단계 완료됨
EVENT_TYPE_DOCUMENT_STEP_STARTED문서 단계가 시작됨
EVENT_TYPE_DOCUMENT_PHOTO_CAPTURED문서 사진이 촬영됨
EVENT_TYPE_DOCUMENT_UPLOADED_FROM_GALLERY갤러리에서 문서가 업로드됨
EVENT_TYPE_DOCUMENT_STEP_FINISHED문서 단계 완료됨
EVENT_TYPE_SESSION_ENDED세션이 타임아웃으로 종료되었거나 새 세션이 생성됨
EVENT_TYPE_ERROR_ON_DOCUMENT_STEP문서 단계에서 오류 발생
구성 가능한 처리

이벤트 집합은 변경될 수 있습니다. 엔드포인트가 반응하는 이벤트는 하드코딩된 상수가 아닌 구성으로 처리하세요 — 그러면 새로운 이벤트를 배포 없이 활성화할 수 있습니다.

전체 프로세스 결과 읽기​

웹훅 페이로드는 프로세스가 완료되었음을 알리고 result 필드에 상위 수준의 결과를 포함합니다. 전체 세부 정보(캡처 데이터, 생체 인식 점수, 문서 필드 등)를 가져오려면 적절한 GetProcess 엔드포인트를 호출하세요:

마지막 업데이트 에