CheckResult 接口是认证后的结果查询接口,本文介绍 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代码示例。
请求参数
名称 | 类型 | 是否必选 | 描述 | 示例值 |
MerchantBizId | String | Yes | 您自定义的业务唯一标识,用于后续定位排查问题。 支持长度为32位的字母和数字的组合,请确保唯一。 说明 阿里云服务器不会对该字段的值进行唯一性检查。 为了更好地跟踪,强烈建议保证字段唯一性。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
TransactionId | String | Yes | 初始化接口成功返回的认证唯一标识。为避免篡改风险,应从商户服务端保存的值读取,不应直接信任客户端回传值。 | hksb7ba1b28130d24e015d6******** |
IsReturnImage | String | No | 是否需要返回认证图片资料:
| Y |
返回参数
名称 | 类型 | 描述 | 示例值 | |
HTTP Status Code | Integer | HTTP状态码 | 200 | |
HTTP Body | RequestId | String | 请求ID | 130A2C10-B9EE-4D84-88E3-5384FF03**** |
Code | String | 返回Code,具体信息请参见服务端返回HTTP状态码说明。 | Success | |
Message | String | 返回Code的详细描述。 | success | |
Result.Passed | String | 认证最终结果,取值:
| Y | |
Result.SubCode | String | 认证结果描述。更多信息,请参见ResultObject.SubCode错误码说明。 | 200 | |
Result.ExtIdInfo | String | NFC读取的证件相关结果信息。 更多信息,请参见ExtIdInfo。 | | |
ResultObject.SubCode错误码说明
Subcode基于不同产品方案或集成方式返回,详情可参考下表。
适用方案 | 错误码 | 认证记录是否计费 | 描述和原因建议 |
通用 | 200 | 是 | 认证通过。 |
| 211 | 是 | 证件图片质量或分辨率不符合要求,或者图片本身不完整。请确保证件人像面照片清晰、曝光正常,完整无遮挡,角度无太大偏差。 |
| 212 | 是 | 证件防伪检测存在风险。可能存在翻拍、篡改、复印等高风险操作。 |
| 213 | 是 | 未检测到指定对应证件类型(识别模式)或无法识别证件类型(分类模式)。 建议传入清晰完整且角度正常的证件图片。 |
ExtIdInfo
名称 | 类型 | 描述 | 示例值 |
nfcIdImage | String | NFC读取的证件人脸照片,base64格式。 在发起接口请求时,参数 isReturnImage = Y 且完成认证,则返回此字段。 | base64 |
nfcIdInfo | String | NFC读取的证件字段信息。 目前仅支持全球护照,字段信息见下表。 |
全球护照
该证件类型通过识别全球ICAO协议样式的e-Passport中MRZ标准协议内容,输出固定格式的护照字段,解决不同国家护照卡面内容格式差异带来的兼容性风险。
字段 | 类型 | 描述 |
surname | String | 姓(基于MRZ识别的拉丁文) |
givenname | String | 名(基于MRZ识别的拉丁文) |
sex | String | 性别(F或M) |
birthDate | String | 出生日期(yyyy-mm-dd 格式) |
passportNo | String | 护照号 |
nationality | String | 国籍(3位数国家代码) |
expiryDate | String | 失效日期(yyyy-mm-dd 格式) |
countryCode | String | 护照签发机构所在国家代码(3位数国 家代码) |