功能描述
支持中国大陆居民二代身份证正反面所有字段的识别,包括姓名、性别、民族、出生日期、住址、公民身份证号、签发机关、有效期限;具备身份证照片、人像照片的裁剪功能和翻拍、PS、复印件告警功能,以及边框和框内遮挡告警、临时身份证告警和身份证有效期不合法告警等扩展功能。
注意:
该功能目前仅提供 API 使用方式。
授权说明
服务开通
注意:
数据万象绑定后,如果您手动对存储桶进行数据万象的解绑操作,将无法继续使用该功能。
使用限制
费用说明
请求
请求示例
该请求能够对已存储在 COS 的身份证图片进行相应处理操作,返回识别结果。
GET /<ObjectKey>?ci-process=IDCardOCR&CardSide=<CardSide>&Config=<Config> HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>
说明:
请求头
请求参数
参数名称 | 描述 | 类型 | 是否必选 |
ObjectKey | 对象文件名,例如:folder/document.jpg | String | 是 |
ci-process | 数据万象处理能力,身份证识别固定为 IDCardOCR | String | 是 |
CardSide | FRONT:身份证有照片的一面(人像面) BACK:身份证有国徽的一面(国徽面) 该参数如果不填,将为您自动判断身份证正反面 | String | 否 |
Config | 以下可选字段均为 bool 类型,默认 false: CropIdCard,身份证照片裁剪(去掉证件外多余的边缘、自动矫正拍摄角度) CropPortrait,人像照片裁剪(自动抠取身份证头像区域) CopyWarn,复印件告警 BorderCheckWarn,边框和框内遮挡告警 ReshootWarn,翻拍告警 DetectPsWarn,PS 检测告警 TempIdWarn,临时身份证告警 InvalidDateWarn,身份证有效日期不合法告警 Quality,图片质量分数(评价图片的模糊程度) MultiCardDetect,是否开启多卡证检测 参数设置方式参考: Config = {"CropIdCard":true,"CropPortrait":true} | String | 否 |
请求体
该请求无请求体。
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><IdInfo>身份证识别信息</IdInfo><AdvancedInfo>身份证识别信息</AdvancedInfo></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
IdInfo | Response | 身份证识别信息 | Container |
AdvancedInfo | Response | 扩展信息,不请求则不返回 | Container |
IdInfo身份证识别信息中包含如下内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Name | IdInfo | 人像面包含信息如下: 性别/民族/出生日期/地址/身份证号 国徽面包含信息如下: 发证机关/证件有效期 | String |
DetectedText | IdInfo | 识别的文本内容 | String |
Score | IdInfo | 识别内容的置信度分数,取值为[0, 100] | Int |
Location | IdInfo | 识别内容的位置。依次为左上、右上、右下、左下。 | String |
AdvancedInfo扩展信息中包含如下内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
IdCard | AdvancedInfo | 裁剪后身份证照片的 Base64编码,设置 Config.CropIdCard 为 true 时返回 | String |
Portrait | AdvancedInfo | 身份证头像照片的 Base64编码,设置 Config.CropPortrait 为 true 时返回 | String |
Quality | AdvancedInfo | 图片质量分数,设置 Config.Quality 为 true 时返回(取值范围:0~100,分数越低越模糊,建议阈值≥50) | String |
BorderCodeValue | AdvancedInfo | 身份证边框不完整告警阈值分数,设置 Config.BorderCheckWarn 为 true 时返回(取值范围:0~100,分数越低边框遮挡可能性越低,建议阈值≥50) | String |
WarnInfos | IdInfo | 告警信息,Code 告警码列表和释义: 9100 身份证有效日期不合法告警 9101 身份证边框不完整告警 9102 身份证复印件告警 9103 身份证翻拍告警 9104 临时身份证告警 9105 身份证框内遮挡告警 9106 身份证 PS 告警 可能存在多个 WarnInfos | String |
实际案例
请求
GET /test.jpg?ci-process=IDCardOCR&CardSide=FRONT&Config={"CropIdCard":true, "CropIdCard":true} HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=****************************************Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.com
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 414641Date: Thu, 15 Jun 2017 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><Status>1</Status><IdInfo><Name>姓名</Name><DetectedText>李明</DetectedText><Score>100</Score><Location><Point>544,967</Point><Point>544,1063</Point><Point>829,1063</Point><Point>829,967</Point></Location></IdInfo><IdInfo><Name>性别</Name><DetectedText>男</DetectedText><Score>99</Score><Location><Point>545,1078</Point><Point>545,1162</Point><Point>708,1162</Point><Point>708,1078</Point></Location></IdInfo><IdInfo><Name>民族</Name><DetectedText>汉</DetectedText><Score>99</Score><Location><Point>860,1078</Point><Point>860,1164</Point><Point>1015,1164</Point><Point>1015,1078</Point></Location></IdInfo><IdInfo><Name>出生(日期)</Name><DetectedText>1987年1月1日</DetectedText><Score>99</Score><Location><Point>547,1177</Point><Point>547,1282</Point><Point>1065,1282</Point><Point>1065,1177</Point></Location></IdInfo><IdInfo><Name>住(地)址</Name><DetectedText>北京市石景山区高新技术园腾讯大楼</DetectedText><Score>96</Score><Location><Point>550,1295</Point><Point>550,1544</Point><Point>1187,1544</Point><Point>1187,1295</Point></Location></IdInfo><IdInfo><Name>公民身份证号(证号)</Name><DetectedText>440524198701010014</DetectedText><Score>99</Score><Location><Point>762,1563</Point><Point>762,1701</Point><Point>1646,1701</Point><Point>1646,1563</Point></Location></IdInfo></Response>
错误码
错误码 | 描述 |
FailedOperation.DownLoadError | 文件下载失败 |
FailedOperation.EmptyImageError | 图片内容为空 |
FailedOperation.IdCardInfoIllegal | 身份证信息不合法(身份证号、姓名字段校验非法等) |
FailedOperation.ImageBlur | 图片模糊 |
FailedOperation.ImageDecodeFailed | 图片解码失败 |
FailedOperation.ImageNoIdCard | 图片中未检测到身份证 |
FailedOperation.ImageSizeTooLarge | 图片尺寸过大,请参考输出参数中关于图片大小限制的说明 |
FailedOperation.MultiCardError | 照片中存在多张卡 |
FailedOperation.OcrFailed | OCR 识别失败 |
FailedOperation.UnKnowError | 未知错误 |
FailedOperation.UnOpenError | 服务未开通 |
InvalidParameter.ConfigFormatError | Config 格式错误 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误 |
LimitExceeded.TooLargeFileError | 文件内容太大 |
ResourcesSoldOut.ChargeStatusException | 计费状态异常 |