History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
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 | 否 |
<Response><IdInfo>身份证识别信息</IdInfo><AdvancedInfo>身份证识别信息</AdvancedInfo></Response>
节点名称（关键字） | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
IdInfo | Response | 身份证识别信息 | Container |
AdvancedInfo | Response | 扩展信息，不请求则不返回 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
Name | Response.IdInfo | 姓名（人像面） | String |
Sex | Response.IdInfo | 性别（人像面） | String |
Nation | Response.IdInfo | 民族（人像面） | String |
Birth | Response.IdInfo | 出生日期（人像面） | String |
Address | Response.IdInfo | 地址（人像面） | String |
IdNum | Response.IdInfo | 身份证号（人像面） | String |
Authority | Response.IdInfo | 发证机关（国徽面） | String |
ValidDate | Response.IdInfo | 证件有效期（国徽面） | String |
节点名称（关键字） | 父节点 | 描述 | 类型 |
IdCard | Response.AdvancedInfo | 裁剪后身份证照片的 Base64编码，设置 Config.CropIdCard 为 true 时返回 | String |
Portrait | Response.AdvancedInfo | 身份证头像照片的 Base64编码，设置 Config.CropPortrait 为 true 时返回 | String |
Quality | Response.AdvancedInfo | 图片质量分数，设置 Config.Quality 为 true 时返回（取值范围：0~100，分数越低越模糊，建议阈值≥50） | String |
BorderCodeValue | Response.AdvancedInfo | 身份证边框不完整告警阈值分数，设置 Config.BorderCheckWarn 为 true 时返回（取值范围：0~100，分数越低边框遮挡可能性越低，建议阈值≥50） | String |
WarnInfos | Response.AdvancedInfo | 告警信息，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><IdInfo><Name>李明</Name><Sex>男</Sex><Nation>汉</Nation><Birth>1987/1/1</Birth><Address>北京市石景山区高新技术园腾讯大楼</Address><IdNum>440524198701010014</IdNum></IdInfo><AdvancedInfo><IdCard>裁剪后身份证照片的 Base64 编码</IdCard><Portrait>身份证头像照片的 Base64 编码</Portrait></AdvancedInfo></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 | 计费状态异常 |
文档反馈