跳转到主要内容

事件类型

Webhook 负载描述了流程状态的转换。本页记录了负载结构及 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 时返回。
状态词汇表

Webhook 负载中的 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_READ二维码已扫描
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文件步骤发生错误
可配置处理

事件集合可能会演变。请将您的端点所响应的事件视为配置项，而非硬编码常量——这样在启用新事件时无需重新部署。

读取完整流程结果​

Webhook 负载表明流程已完成，并在 result 字段中包含高层级结果。要获取完整详情——采集数据、生物特征分数、文件字段等——请调用相应的 GetProcess 端点：

最后更新 于