解密 HumanID
通过呈现匹配的实时人脸恢复身份数据。
menu_bookAPI 参考:解密 HumanIDexpand_more
官方指南: docs.verifik.co/functions/decrypt-zelfproof (请求与响应字段、可选密码与验证密钥及示例调用)。 相关: 创建 ZelfProof, 创建二维码 ZelfProof, 预览 ZelfProof.
基础 URL 为 https://api.verifik.co。使用 Content-Type: application/json 与 Authorization: Bearer <access token> 发送 JSON(与本演示登录后的 JWT 相同)。
POST /v2/human-id/decrypt
将人脸图与证明比对,匹配成功时在常见的签名 data 信封内返回解密的公开字段及相关载荷(例如人脸裁剪与难度)。
| 字段 | 值 |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer <token> |
| 参数 | 必填 | 说明 |
|---|---|---|
| faceBase64 | 是 | 人脸图像为原始 base64(本演示格式与其他生物识别演示相同) |
| os | 是 | DESKTOP, IOS, or ANDROID — DESKTOP、IOS 或 ANDROID(演示使用 DESKTOP) |
| zelfProof | 是 | 来自粘贴的 HumanID 字符串,或本表单中从二维码图像提取 |
| password | 否 | 仅当创建证明时设置了密码 |
| verifierKey | 否 | 若创建证明时使用了验证密钥 |
await fetch("https://api.verifik.co/v2/human-id/decrypt", {
method: "POST",
headers: {
"Content-Type": "application/json",
Authorization: `Bearer ${accessToken}`,
},
body: JSON.stringify({
faceBase64: "<base64>",
os: "DESKTOP",
zelfProof: "<human id string>",
}),
});POST /v2/human-id/preview-zelf-id-qr
当用户提供 HumanID 二维码的 PNG 或 JPEG 时使用。API 读取二维码载荷,运行与字符串预览同类的预览,并返回可传入 decrypt 的 zelfProof。创建时若使用 verifierKey 则可选传入。解密使用相同的 JSON 头。
| 参数 | 必填 | 说明 |
|---|---|---|
| zelfProofQRCode | 是 | 图像为 data URL(data:image/png;base64,...)或 API 接受的其他形式(本演示由文件构建 data URL) |
| verifierKey | 否 | 与证明使用验证密钥时 decrypt 上的语义相同 |
await fetch("https://api.verifik.co/v2/human-id/preview-zelf-id-qr", {
method: "POST",
headers: {
"Content-Type": "application/json",
Authorization: `Bearer ${accessToken}`,
},
body: JSON.stringify({
zelfProofQRCode: "data:image/png;base64,<...>",
}),
});- 解密使用 @humanauthn/api-client 的 decryptHumanId。二维码上传先调用 previewZelfIdQr,再用返回的证明字符串解密。
- 成功响应遵循 Verifik 模式:data 对象(若项目启用签名则常有 signature)。
- 若要在无人脸图的情况下检查证明,请打开「预览 HumanID」演示(previewHumanId)或上方链接的 Preview ZelfProof 指南。
menu_book
相关文档
docs.verifik.co 官方指南