本文介绍如何通过CheckResult接口查询证件OCR识别方案的认证结果。
接口说明
接口名:CheckResult
请求方法:HTTPS POST
接口说明:当您收到回调通知之后,可以在服务端通过该接口获取相应的认证结果。
重要ID Verification服务结果默认存储30天,超期系统自动删除,请您在认证结束后的30天内查询认证结果。
QPS限量:API独享QPS限量,详情请参见ID Verification服务端API QPS限量说明。
服务地址:
说明内网指的是阿里云同地域产品之间的内部通信网络,如果您的业务服务器部署在阿里云的对应地域,可以通过内网域名访问 ID Verification 服务,以获得更安全、稳定的网络通信质量。
中国香港
公网:
cloudauth-intl.cn-hongkong.aliyuncs.com内网:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
在线调试和集成
在调试和集成前,请确保您已完整阅读使用OpenAPI调试和集成服务端API文档,充分了解API接口在OpenAPI平台的调用方式和SDK及其代码的获取方式。
您可以在OpenAPI Explorer中直接运行本接口进行调试,并生成本接口的SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 描述 | 示例值 |
MerchantBizId | String | Yes | 您自定义的业务唯一标识,用于后续定位排查问题。支持长度为32位的字母和数字的组合,请确保唯一。 说明 阿里云服务器不会对该字段的值进行唯一性检查。为了更好地跟踪,强烈建议保证字段唯一性。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
TransactionId | String | Yes | 整个认证流程的唯一标识。该值需要调用 Initialize 接口获取。 重要 为避免篡改风险,该值必须使用您Initialize接口时服务端存储的TransactionId,不建议使用客户端回调的TransactionId。 | hksb7ba1b28130d24e015d6******** |
IsReturnImage | String | No | 是否需要返回认证图片资料:
| Y |
返回数据
名称 | 类型 | 描述 | 示例值 | |
HTTP Status Code | Integer | HTTP状态码。 | 200 | |
HTTP Body | RequestId | String | 请求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF03**** |
Code | String | Success | ||
Message | String | 返回Code的详细描述。 | success | |
Result.Passed | String | 认证最终结果。取值:
| Y | |
Result.SubCode | String | 认证结果描述。更多信息,请参见 | 200 | |
Result.ExtIdInfo | String | 证件OCR识别相关结果信息。关于JSON格式,请参见右侧示例。更多信息,请参见ExtIdInfo。 | | |
ExtIdInfo
名称 | 类型 | 描述 | 示例值 |
ocrIdPassed | String | 证件OCR识别阶段的最终结果:
| N |
idImage | String | 证件OCR照片,base64格式。例如在发起接口请求时,参数isReturnImage=Y且证件OCR流程顺利完成,则返回此字段。 | base64 |
ocrIdInfo | String | 证件OCR字段信息。更多信息,请参见OCR识别返回字段。 说明 如果证件OCR流程失败,则该字段值为空。 | |
spoofInfo | String | 证件防伪检测结果,包括风险判定结果和风险类型: 说明 仅当Initialize接口中 IdSpoof = Y 时,才会开启卡证检测。 否则 spoofResult 默认返回N,spoofType 为空。
| |
ocrIdEditInfo | String | 在OCR结果页二次编辑后,用户提交的证件OCR字段信息。该功能适用客户端配置选择启用OCR结果编辑页面时(ShowOcrResult)返回。 | |
idBackImage | String | 证件反面OCR照片,base64格式。 说明 如在发起接口请求时,参数isReturnImage = Y且证件OCR流程顺利完成,则返回此字段。 | base64 |
ocrIdBackInfo | String | 证件反面OCR字段信息。 重要 如果证件OCR流程失败,则该字段值为空。 | |
spoofBackInfo | String | 证件防伪检测结果,包括风险判定结果和风险类型: 说明 仅当Initialize接口中 IdSpoof = Y 时,才会开启卡证检测。 否则 spoofResult 默认返回N,spoofType 为空。
说明 算法预测结果,该字段可能无法返回,建议业务上避免设置必要依赖。 | |
返回Code
HTTP状态码 | Code | Message描述 |
200 | Success | 请求成功。 |
400 | MissingParameter | 参数不能为空。 |
InvalidParameter | 非法参数。 | |
TransactionIdInvalid | 无效Transaction id。 | |
403 | Forbidden.RAMUserAccessDenied | 需要给RAM用户授予AliyunAntCloudAuthFullAccess的操作权限。更多信息,请参见授权RAM用户访问服务。 |
Forbidden.AccountAccessDenied | 确保您开通了ID verifycation,并且保证账户未欠费。 | |
Throttling.Api | API限流拦截。 | |
404 | ProcessNotCompleted | 整个认证流程未完成。 |
500 | InternalError | 系统内部错误,请反馈工程师排查。 |
503 | ServiceUnavailable | 服务不可用,请反馈工程师排查。 |
ResultObject.SubCode错误码说明
Subcode基于不同产品方案或集成方式返回,详情可参考下表。
适用方案 | 错误码 | 认证记录是否计费 | 描述和原因建议 |
通用 | 200 | 是 | 认证通过。 |
| 211 | 是 | 证件图片质量或分辨率不符合要求,或者图片本身不完整。请确保证件人像面照片清晰、曝光正常,完整无遮挡,角度无太大偏差。 |
| 212 | 是 | 证件防伪检测存在风险。可能存在翻拍、篡改、复印等高风险操作。 |
| 213 | 是 | 未检测到指定对应证件类型(识别模式)或无法识别证件类型(分类模式)。 建议传入清晰完整且角度正常的证件图片。 |
OCR识别返回字段
中国香港居民身份证
智能身份证2003和2018版本均支持。
字段 | 类型 | 描述 |
name | String | 姓名 |
englishName | String | 姓名(英文) |
nameCode | String | 中文姓名电码 |
sex | String | 性别,取值:
|
birthDate | String | 出生日期 |
idNumber | String | 身份证号码 |
currentIssueDate | String | 登记日期 |
firstIssueDate | String | 首次登记的月份和年份 |
isPermanent | String | 是否属于永久性居民身份证,取值:
|
symbols | String | 符号标记。例如:"***AZ"。 |
往来港澳通行证
字段 | 类型 | 描述 |
name | String | 姓名 |
englishName | String | 姓名(拼音) |
sex | String | 性别 |
birthDate | String | 出生日期 |
idNumber | String | 证件号码 |
issueDate | String | 签发日期 |
expiryDate | String | 失效日期 |
placeOfIssue | String | 签发地点 |
originOfIssue | String | 签发机关 |
港澳居民来往内地通行证
字段 | 类型 | 描述 |
name | String | 姓名 |
englishName | String | 姓名(英文) |
sex | String | 性别 |
birthDate | String | 出生日期 |
idNumber | String | 证件号码 |
issueDate | String | 签发日期 |
expiryDate | String | 失效日期 |
originOfIssue | String | 签发机关 |
台湾居民来往大陆通行证
字段 | 类型 | 描述 |
name | String | 姓名 |
englishName | String | 姓名(拼音) |
sex | String | 性别 |
birthDate | String | 出生日期 |
idNumber | String | 证件号码 |
issueDate | String | 签发日期 |
expiryDate | String | 失效日期 |
originOfIssue | String | 签发机关 |
placeOfIssue | String | 签发地点 |
全球护照
该证件类型通过识别全球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位数国 家代码) |
中国澳门居民身份证
字段 | 类型 | 描述 |
surnameCN | String | 姓(中文) |
givennameCN | String | 名(中文) |
surname | String | 姓(英文) |
givenname | String | 名(英文) |
sex | String | 性别 |
birthDate | String | 出生日期 |
idNumber | String | 证件号码 |
expiryDate | String | 失效日期 |
placeOfBirth | String | 出生地代码。例如:"AS"。 |
中华人民共和国居民身份证
字段 | 类型 | 描述 |
name | String | 姓名 |
sex | String | 性别 |
ethnicity | String | 民族 |
birthDate | String | 出生日期 |
idNumber | String | 身份证号 |
address | String | 地址 |
province | String | 省 说明 预留字段,默认返回为空。 |
city | String | 市 说明 预留字段,默认返回为空。 |
originOfIssue | String | 签发机关 |
issueDate | String | 签发日期 |
expiryDate | String | 失效日期 |