本文介绍如何通过CheckResult接口查询认证结果。
接口信息
接口名:CheckResult
请求方法:HTTPS POST
接口说明:当您收到回调通知之后,可以在服务端通过该接口获取相应的认证状态和认证资料。
重要ID Verification服务结果默认存储30天,超期系统自动删除,请您在认证结束后的30天内查询认证结果。
QPS限量:API独享QPS限量,详情请参见服务端API QPS限量说明。
服务地址:
说明内网访问优势:内网指阿里云同一地域内各产品间的私有通信网络。若您的业务服务器部署于阿里云对应地域,请使用内网域名访问 ID Verification 服务,以获得更安全、稳定的通信质量。
海外访问优化建议:海外网络环境复杂,建议参考服务端网络耗时优化,优化集成方案,降低网络延迟及请求失败概率。
新加坡
公网:
cloudauth-intl.ap-southeast-1.aliyuncs.com内网:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
印度尼西亚
公网:
cloudauth-intl.ap-southeast-5.aliyuncs.com内网:
cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com
中国香港
公网:
cloudauth-intl.cn-hongkong.aliyuncs.com内网:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
马来西亚(吉隆坡)
公网:
cloudauth-intl.ap-southeast-3.aliyuncs.com内网:
cloudauth-intl-vpc.ap-southeast-3.aliyuncs.com
在线调试和集成
在调试和集成前,请确保您已完整阅读使用OpenAPI文档,充分了解API接口在OpenAPI平台的调用方式和SDK及其代码的获取方式。
您可以在OpenAPI Explorer中直接运行本接口进行调试,并生成本接口的SDK代码示例。
接入注意事项
TransactionId 存储规范:TransactionId 为认证记录的服务端可信标识,须与商户业务 ID 绑定,并持久化存储于服务端。
日志保存期限:认证结果日志默认保存 30 天,到期后系统将自动删除。商户须在有效期内完成查询,并按合规要求妥善保存所需数据。
视频获取与留存合规:视频仅在对应功能开关开启且认证流程成功时返回。存证视频下载链接的有效期为 15 分钟,原视频将在认证完成 30 分钟后自动删除。若业务需留存视频,请及时下载,并严格遵守当地隐私与数据合规要求。
图片获取规范:认证图片仅在 IsReturnImage=Y 且人脸验证成功时返回。鉴于 Base64 数据体积较大,若无展示或留存需求,请保持该参数为默认值 N。
接口状态与认证结果区分:Code=Success 仅表示接口调用成功。最终认证结论须以 Result.Passed 和 Result.SubCode 字段为准。
认证失败排查:当 Passed=N 时,需结合 SubCode与ExtFaceInfo字段,综合判定失败原因。
字段分布说明
App SDK接入与 Web SDK 接入使用相同的 CheckResult 接口和查询参数,主认证结论结构一致,差异主要集中在 ExtFaceInfo 的扩展字段以及移动端H5的降级信息。
分类 | 字段 | 说明 |
共有输出 | 通用响应、认证结论 | 两种集成模式均可能返回,具体是否返回由认证流程和 InitializeV2 配置决定。 |
Web SDK 特有 |
| Web 侧人脸质量、遮挡、年龄、性别及实际降级策略。 |
App 特有 | 无 | 无 |
请求参数
字段 | 类型 | 必选 | 说明 | 示例值 |
MerchantBizId | String | 是 | 商户业务唯一标识;由32 位字母和数字组成。必须与 InitializeV2 请求中使用的值一致。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
TransactionId | String | 是 | 初始化接口成功返回的认证唯一标识。为避免篡改风险,应从商户服务端保存的值读取,不应直接信任客户端回传值。 | hksb7ba1b28130d24e015d6******** |
IsReturnImage | String | 否 | 是否返回认证图片资料(若方案包含证件,则同时返回证件图片):
| Y |
返回数据
名称 | 类型 | 描述 | 示例值 | |
HTTP Status Code | Integer | HTTP状态码。 | 200 | |
HTTP Body | RequestId | String | 请求ID,用于问题排查。 | 130A2C10-B9EE-4D84-88E3-5384FF03**** |
Code | String | 服务端返回码,具体信息请参见服务端返回HTTP状态码说明。 | Success | |
Message | String | 返回码的详细说明。 | success | |
Result.Passed | String | 认证最终结果,取值:
| Y | |
Result.SubCode | String | 认证结果描述。更多信息,请参见Result.SubCode认证结果子码说明。 | 200 | |
Result.ExtFaceInfo | String | 活体人脸验证相关结果。具体信息,请参见Result.ExtFaceInfo。 | | |
Result.ExtInfo | String | 其他认证信息,主要包含移动端H5的实际降级信息。具体信息,请参见Result.ExtInfo。 | | |
Result.ExtFaceInfo
名称 | 类型 | 描述 | 示例值 |
faceImg | String | 活体人脸图片,Base64格式。仅 | base64格式 |
docVideoUrl | String | 存证视频的OSS下载地址。仅 InitializeV2 参数 | https://aliyun-cloudauth.oss-aliyuncs.com/******.webm |
faceAttack | String | 是否检测到活体攻击:
| N |
faceAttackScore (已下线) | Double | 活体攻击风险分,范围0~100 目前活体攻击风险由大模型能力输出,无风险分概念,此字段已下线。 | 80 |
guardRiskScore | Double | 设备风险分,取值0~100,分数越高代表设备风险越高。 | 90 |
deviceToken | String | 设备助手DeviceToken,当完整集成设备助手模块时返回,可用于查询设备助手服务端接口,获取设备风险详情。
| e0c34a77f5ac40a5aa5e6ed20c35**** |
faceAttributeInfo | String | 检测传入图片中的主体人脸(离镜头最近、面部面积最大且清晰的人脸)的相关面部属性。检测结果以字符串形式返回,据此决策消费内容。 返回字段定义如下:
| |
Result.ExtInfo
字段 | 类型 | 说明 |
procedurePriority | String | 移动端 H5 认证的实际降级方式:
|
Result.SubCode认证结果子码说明
错误码 | 认证记录是否计费 | 描述和原因建议 |
200 | 是 | 认证通过。 |
205 | 是 | 【活体攻击】活体检测存在风险。 |
206 | 是 | 【活体攻击】业务策略限制。开启安全模式后,将对认证的设备等环境进行安全检测,若检测到可能存在风险,则判定认证结果不通过。 可以按照如下方法排查处理:
|