跳转到主要内容
获取自拍照GET

使用创建流程时 Human Plugin 返回的 id,读取该流程中采集的自拍照。

Markdown

GET /v1/processes/{id}/selfie

id 是创建响应中的 UUID。该请求没有请求体,也没有查询参数。

curl http://human-plugin.internal:8080/v1/processes/17e4546e-6109-4240-8c0b-4ba98474a104/selfie

Human Plugin 不会保留自拍照的副本:每次调用都会重新获取。

响应​

200 OK,返回 base64 格式的图像及其类型:

{
"fileContents": "/9j/4AAQSkZJRgABAQAAAQABAAD…",
"contentType": "image/jpeg"
}

将其保存为文件:

curl -s http://human-plugin.internal:8080/v1/processes/17e4546e-6109-4240-8c0b-4ba98474a104/selfie \
| jq -r .fileContents | base64 -d > selfie.jpg

可用性​

  • 只有确实有自拍照的流程才有自拍照:通过 imageBase64 发送,或从此人处采集。
  • 对于 Journey 流程,只有在此人完成采集之后才会有自拍照。在此之前,请求会被以 400 拒绝,且 message 以 process state must be finished 开头。请先读取流程,待其变为 PROCESS_STATE_FINISHED 后再获取自拍照。
  • 自拍照在流程完成后的有限时间内可用。如果之后还需要使用,请从该响应中自行存储。

处理图像​

自拍照属于生物识别数据。Human Plugin 从不存储或记录它,并且响应以 Cache-Control: no-store 发送。也请不要让它出现在您的网关和应用程序日志中。

错误​

状态码message含义
400process state must be finished…Journey 流程的采集尚未完成。请先读取该流程
404PROCESS_NOT_FOUNDid 不是 UUID 或未知
404SELFIE_NOT_FOUND该流程没有自拍照:未进行采集、在开始之前就已失败,或自拍照已不再可用
4xx拒绝原因 message请求被拒绝。原因见 message 和 details
502UPSTREAM_UNAVAILABLE未能及时获取自拍照。请稍后重试
503DATABASE_UNAVAILABLE数据库故障。请稍后重试

读取可以安全重试。404 不会因重试而改变。

下一步​

流程生命周期