简介
本文档提供关于身份证识别的相关 API 概览以及 SDK 示例代码。
注意:
COS Javascript SDK 版本需要大于等于 v1.3.2。
API | 操作描述 |
支持中国大陆居民二代身份证正反面所有字段的识别,包括姓名、性别、民族、出生日期、住址、公民身份证号、签发机关、有效期限;具备身份证照片、人像照片的裁剪功能和翻拍、PS、复印件告警功能,以及边框和框内遮挡告警、临时身份证告警和身份证有效期不合法告警等扩展功能。 |
身份证识别
功能说明
支持中国大陆居民二代身份证正反面所有字段的识别,包括姓名、性别、民族、出生日期、住址、公民身份证号、签发机关、有效期限;具备身份证照片、人像照片的裁剪功能和翻拍、PS、复印件告警功能,以及边框和框内遮挡告警、临时身份证告警和身份证有效期不合法告警等扩展功能。
使用示例
function aIIDCardOCR() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/11459const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};cos.request({Bucket: config.Bucket,Region: config.Region,Method: 'GET', // 固定值,必须Key: 'ci/card.jpeg', // 对象文件名,必须,例如:folder/document.jpgQuery: {// 数据万象处理能力,身份证识别固定为 IDCardOCR;是否必传:是'ci-process': 'IDCardOCR',// FRONT:身份证有照片的一面(人像面)BACK:身份证有国徽的一面(国徽面)该参数如果不填,将为您自动判断身份证正反面;是否必传:否CardSide: 'FRONT',// 以下可选字段均为 bool 类型,默认 false:CropIdCard,身份证照片裁剪(去掉证件外多余的边缘、自动矫正拍摄角度)CropPortrait,人像照片裁剪(自动抠取身份证头像区域)CopyWarn,复印件告警BorderCheckWarn,边框和框内遮挡告警ReshootWarn,翻拍告警DetectPsWarn,PS 检测告警TempIdWarn,临时身份证告警InvalidDateWarn,身份证有效日期不合法告警Quality,图片质量分数(评价图片的模糊程度)MultiCardDetect,是否开启多卡证检测参数设置方式参考:Config = {"CropIdCard":true,"CropPortrait":true};是否必传:否// Config: {},},},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}});}aIIDCardOCR();
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Bucket | 存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 | String | 是 |
Region | String | 是 | |
Method | 固定值:GET | String | 是 |
Key | 对象文件名,例如:folder/document.jpg | String | 是 |
Query | 其他请求参数 | Container | 是 |
Query 参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
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 | 否 |
回调函数说明
function(err, data) { ... }