本文介绍调用DocOcr接口的纯服务端接入流程。通过该接口实现对身份证件图片的信息自动提取,及相关防伪风险判断。
接口说明
接口名:DocOcr
请求方法:HTTPS POST
接口说明:调用DocOcr接口,通过OCR技术对各种身份证件(如护照、身份证等)进行自动信息提取及相关防伪检查。
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代码示例。
传入图片格式要求
为了确保模型效果稳定,请传入满足以下所有条件的图片:
图片格式:JPG、JPEG、PNG。
图片大小:推荐50~100 KB,最大不超过1 MB。
说明图片转base64格式后,通常会导致数据体积增加。如您需要使用base64格式传参,请保证原始图片的体积不超过0.6MB,以满足1MB的最大数据传输限制。
图片分辨率:图片长宽需要大于 200像素,小于 8192 像素,推荐480*640(高*宽)。
图片质量建议:
卡证图片需要保持四个边角完整,避免手持时遮挡影响检测。
卡证图片内容清晰、无遮挡和无曝光光斑,卡证图片角度正常,避免倾斜或者倒置。
卡证图片面积需要占比图片面积60%以上,避免卡面图片面积过小影响识别。
建议采用真实证件拍摄。
请求参数
照片传入提供两种方式,任选其一即可。
IdOcrPictureBase64
IdOcrPictureUrl
名称 | 类型 | 是否必选 | 描述 | 示例值 |
ProductCode | String | 是 | 要接入的产品方案。取值ID_OCR_MIN:使用证件OCR识别API。 | ID_OCR_MIN |
SceneCode | String | 否 | 您自定义的认证场景ID,用于后续控制台输入此场景ID查询相关记录。支持长度为10位的字母、数字和下划线的组合。 | 1234567890 |
MerchantBizId | String | 是 | 您自定义的业务唯一标识,用于后续定位排查问题。支持长度为32位的字母和数字的组合,请确保唯一。 说明 阿里云服务器不会对该字段的值进行唯一性检查。为了更好地跟踪,强烈建议保证字段唯一性。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
MerchantUserId | String | 是 | 您自定义的用户ID,或者其他可以识别特定用户的标识,例如:手机号码、邮箱地址等。强烈建议对该字段的值进行预先脱敏,例如对值进行哈希处理。 | 123456789 |
IdOcrPictureBase64 | String | 是 | 证件头像面图片Base64编码。如果您选择IdOcrPictureBase64(照片Base64编码)方式传入证件照片,请注意检查照片大小,不要传入过大的照片。 | base64 |
IdOcrPictureUrl | String | 是 | 证件头像面图片地址,公网可访问的HTTP、HTTPS链接。 | https://*** |
DocType | String | 是 | 证件类型,以8位数字组合作为唯一标识,详见证件类型列表。 | F |
Ocr | String | 是 | 是否开启OCR功能进行证件信息自动提取。
| T |
IdFaceQuality | String | 否 | 是否返回证件人脸的质量分,默认不开启。 说明 仅证件人像面照片有效。
| F |
Spoof | String | 否 | 是否开启证件防伪功能,默认不开启。 说明 仅证件人像面照片有效。
| F |
IdThreshold | String | 否 | 自定义OCR质量检测阈值模式:
| 3 |
CardSide | String | 否 | 区分证件国徽面和人像面 ,不传默认人像面 。
重要 仅适用中华人民共和国居民身份证 | OCR_ID_NATIONAL_EMBLEM |
证件类型列表
DocType | 对应证件 |
01000000 | 全球护照 |
00000006 | 中国香港居民身份证(2003版) |
00000008 | 中国香港居民身份证(2018版) |
00000007 | 往来港澳通行证 |
00000009 | 港澳居民来往内地通行证 |
000000011 | 中国澳门身份证 |
000000012 | 台湾居民来往大陆通行证 |
00000001 | 中国内地第二代居民身份证 |
返回数据
名称 | 类型 | 描述 | 示例值 | |
HTTP Status Code | Integer | HTTP状态码。 | 200 | |
HTTP Body | RequestId | String | 请求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF039**** |
Result.TransactionId | String | 整个认证流程的唯一标识。 | hksb7ba1b28130d24e015d694361b**** | |
Code | String | Success | ||
Message | String | 返回Code的详细描述。 | success | |
Result.Passed | String | 认证结果,取值:
| Y | |
Result.SubCode | String | 认证结果描述。更多信息,请参见ResultObject.SubCode错误码说明。 | 200 | |
Result.ExtIdInfo | String | 证件识别相关结果信息。关于JSON格式,请参见右侧示例。更多信息,请参见ExtIdInfo。 | | |
ExtIdInfo
名称 | 类型 | 描述 | 示例值 |
ocrIdInfo | String | 证件OCR字段信息。更多信息,请参见OCR识别返回字段。 说明 如果证件OCR流程失败,则该字段值为空。 | |
idFaceQualityScore | Double | 上传证件图片中人脸的质量分,取值范围0~100。 | 99.95 |
spoofInfo | String | 证件防伪检测结果,包括风险判定结果和风险类型: 说明 仅当Initialize接口中 IdSpoof = Y 时,才会开启卡证检测。 否则 spoofResult 默认返回N,spoofType 为空。
| |
返回Code
HTTP状态码 | Code | Message说明 |
200 | Success | 请求成功。 |
400 | MissingParameter | 参数不能为空。 |
InvalidParameter | 非法参数。 | |
401 | UnqualifiedPhoto | 传入的图片不可读,或图片分辨率不符合要求,建议更换图片。 需确保照片清晰、曝光正常,完整无遮挡,角度无太大偏差。 |
DataDuplication | 同时传入Base64编码的图片和Url图片地址,此二参数任选其一即可。 | |
ToolargeImage | 图片尺寸过大,建议压缩图片或更换图片上传方式。 | |
DownloadTimeout | URL图片下载超时。 | |
403 | Forbidden.RAMUserAccessDenied | 需要给RAM用户授予 AliyunAntCloudAuthFullAccess 操作权限。更多信息,请参见授权RAM用户访问服务。 |
Forbidden.AccountAccessDenied | 确保您开通了ID verifycation,并且保证账户未欠费。 | |
Throttling.Api | API限流拦截。 | |
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 | 失效日期 |