简介
本文档提供关于身份证识别的相关 API 概览以及 SDK 示例代码。
API | 操作描述 |
身份证识别 |
身份证识别
功能说明
支持中国大陆居民二代身份证正反面所有字段的识别,包括姓名、性别、民族、出生日期、住址、公民身份证号、签发机关、有效期限;具备身份证照片、人像照片的裁剪功能和翻拍、PS、复印件告警功能,以及边框和框内遮挡告警、临时身份证告警和身份证有效期不合法告警等扩展功能。
示例代码
def cos_ai_id_card_ocr(): # 身份证识别 response, data = client.cos_ai_id_card_ocr( Bucket=bucket_name, ObjectKey="test.jpeg", # CardSide="FRONT", Config='{"CropIdCard":true,"CropPortrait":true}' ) print(response) print(data) return response, data
参数说明
调用 cos_aiid_card_ocr 函数,具体请求参数如下:
参数名称 | 参数描述 | 类型 | 是否必填 |
Bucket | 存储桶名称 | String | 是 |
ObjectKey | 设置对象名称 | 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 为响应头,data 为身份证识别结果,数据类型都为 dict。
response内容
响应体data
响应体具体数据内容如下:
参数名称 | 参数描述 | 类型 |
IdInfo | 身份证识别信息 | Container |
AdvancedInfo | 扩展信息,不请求则不返回 | Container |
AdvancedInfo 节点内容:
参数名称 | 参数描述 | 类型 |
IdCard | 裁剪后身份证照片的 Base64 编码,设置 Config.CropIdCard 为 true 时返回 | String |
Portrait | 身份证头像照片的 Base64 编码,设置 Config.CropPortrait 为 true 时返回 | String |
Quality | 图片质量分数,设置 Config.Quality 为 true 时返回(取值范围:0~100,分数越低越模糊,建议阈值≥50) | String |
BorderCodeValue | 身份证边框不完整告警阈值分数,设置 Config.BorderCheckWarn 为 true 时返回(取值范围:0~100,分数越低边框遮挡可能性越低,建议阈值≥50) | String |
WarnInfos | 告警信息,Code 告警码列表和释义: 9100 身份证有效日期不合法告警 9101 身份证边框不完整告警 9102 身份证复印件告警 9103 身份证翻拍告警 9104 临时身份证告警 9105 身份证框内遮挡告警 9106 身份证 PS 告警 可能存在多个 WarnInfos | String |
IdInfo 节点内容:
参数名称 | 参数描述 | 类型 |
Name | 姓名(人像面) | String |
Sex | 性别(人像面) | String |
Nation | 民族(人像面) | String |
Birth | 出生日期(人像面) | String |
Address | 地址(人像面) | String |
IdNum | 身份证号(人像面) | String |
Authority | 发证机关(国徽面) | String |
ValidDate | 证件有效期(国徽面) | String |