跳转到主要内容
获取流程GET

使用创建流程时 Human Plugin 返回的 id 读取流程。

Markdown

GET /v1/processes/{id}

id 是创建响应中的 UUID。该请求没有认证头,也没有按客户端划分的范围限制:任何能够访问 Human Plugin 的调用方都可以读取其中的任何流程。

curl http://human-plugin.internal:8080/v1/processes/b063041c-7529-4e70-a2b4-c71c00f19801

结果何时返回​

  • 待处理的流程(PROCESS_STATE_CREATED)会在每次读取时被检查,一旦有结果就立即返回结果。
  • 已完成或已失败的流程是最终状态,按原样返回。
  • 被中断的创建请求会在启动约 70 秒后按失败返回。

读取是待处理流程推进的唯一方式:没有后台任务,并且返回到您的 callbackUri 也不会更新 Human Plugin。

响应​

200 OK,结构与创建响应相同:id、state 和 data。

待处理的 Journey:

{ "id": "b063041c-7529-4e70-a2b4-c71c00f19801", "state": "PROCESS_STATE_CREATED", "data": {} }

已完成和已失败的流程​

已完成的流程会在 data 中返回其结果:在 humanToken 中给出此人是谁,在 ndocs 中给出此人的情报;如果流程检查活体,还会返回 liveness。重新验证返回 humanTokenMatch,而不是 humanToken。每个字段都在 data 中的结果中说明。已失败的流程返回 PROCESS_STATE_FAILED,且 data 为空。

已完成的流程:

{
"id": "b063041c-7529-4e70-a2b4-c71c00f19801",
"state": "PROCESS_STATE_FINISHED",
"data": {
"humanToken": { "value": "6d3d71…", "status": "validated" },
"liveness": { "value": "live", "status": "validated" },
"ndocs": {
"distinctClientsCount": 2,
"transactionsCount": 3,
"firstSeen": "2026-09-08",
"lastSeen": "2026-11-03",
"credentials": [
{ "type": "DUI_TYPE_NG_BVN", "countryCode": "NGA", "distinctCredentialCount": 1 }
]
}
}
}

已完成的重新验证,其中 ndocs 描述的是您所确认的那个人:

{
"id": "7f2c9a10-3d4e-4b5f-8a61-0c9e2d7b4a35",
"state": "PROCESS_STATE_FINISHED",
"data": {
"humanTokenMatch": "true",
"liveness": { "value": "live", "status": "validated" },
"ndocs": {
"distinctClientsCount": 2,
"transactionsCount": 4,
"firstSeen": "2026-09-08",
"lastSeen": "2026-11-04",
"credentials": [
{ "type": "DUI_TYPE_NG_BVN", "countryCode": "NGA", "distinctCredentialCount": 1 }
]
}
}
}

已失败的流程:

{ "id": "c41e8b27-95d0-4a8f-b3e6-2f7a1d9c0e58", "state": "PROCESS_STATE_FAILED", "data": {} }

Journey 的 token 和 link 仅在创建时返回,请从该响应中保存。

错误​

状态码message含义
404PROCESS_NOT_FOUNDid 不是 UUID 或未知
502UPSTREAM_UNAVAILABLE流程处于待处理状态,且无法检查其结果。请稍后重试
503DATABASE_UNAVAILABLE数据库故障。请稍后重试

读取可以安全重试。

下一步​

获取自拍照