文档中心

文档目录

身份证OCR

最近更新时间: 2024-04-17 14:49:47

1. 接口描述

通过扫描获取证件内的有效信息，实现证件核心要素信息的精准提取。

用于识别静态身份证图像上的文字信息，通过上传身份证照片，识别照片文字信息并返回，包括姓名、身份证号码、性别、民族、出生年月日、地址、签发机关及有效期，支持多光线多角度，识别准确率高达98%以上。

2. 使用场景

电信行业：手机号实名制登记，运营商要求用户办理新卡或业务变更时进行身份证实名认证。

物流行业：发货人、收货人的身份核实，以确保物流信息安全。

金融行业：用户开户、贷款申请、投资理财等环节的身份验证。

广泛应用于实名认证、网上购票、考试报名、在线平台学习、房地产租赁、酒店入住登记等领域。

3. 接口说明（身份证OCR）

3.1. 发起请求

3.1.1. 接口协议

HTTP POST

3.1.2. 接口方法

https://api.juncyun.com/api/idCardOcr

3.1.3. 报头定义

编码	列表	内容	备注
1）	Accept	application/json
2）	Content-Type	application/json;charset=utf-8

3.1.4. 请求参数

3.1.4.1. 请求参数列表

编码	列表	内容	备注
1）	accessKey	API调用账号（必填，从云极平台获取）
2）	accessSecret	API调用密钥（必填，从云极平台获取）
3）	image	人脸照（必填）	身份证识别的照片,说明：imageType 为 BASE64 时，传入照片的 base64 字符编码，base64 字符串不包含 data:image 前缀，图片类型建议 jpg 格式，建议 1M 以内。图片大小不能大于 2M
4）	imageType	图片类型（必填）	图片类型，枚举值：URL-图片路径 ,BASE64 –图片 BASE64 编码
5）	ocrType	ocr类型（必填）	区分身份证正反面参数（ocrType=0 为正面；ocrType=1 为反面）
6）	detectRisk	是否开启身份证风险类型	是否开启身份证风险类型(身份证复印件)功能，默认不开启，即：false。可选值:true-开启；false-不开启

3.1.4.2. 请求参数示例

{

"accessKey":"87d0373b**********",

"accessSecret":"b20d7c5e1c********************",

"imageType":"BASE64",

"image":"DAQL/xAA+EAACAgEEAAUCAwYD***************",

"ocrType":"0",

"detectRisk":"false"

}

3.1.5. 响应参数

3.1.5.1. 响应参数列表

编码	列表	内容	备注
1）	code	状态码200则为成功
2）	msg	状态说明
3）	success	处理是否成功:取值范围 true，false
4）	data	业务数据如果失败则为空
5）	+address	身份证上地址（仅ocrType为0时返回）
6）	+nation	身份证上民族（仅ocrType为0时返回）
7）	+tradeNo	交易流水号
8）	+fee	是否扣费 0不收费1收费
9）	+issuingDate	签发日期（仅ocrType为1时返回）
10）	+sex	身份证上性别（仅ocrType为0时返回）
11）	+birth	身份证上出生日期（仅ocrType为0时返回）
12）	+imageStatus	图像状态,normal-识别正常，reversed_side-身份证正反面颠倒，non_idcard-上传的图片中不包含身份证，blurred-身份证模糊，not_complete-身份证不完整，over_dark-欠曝，over_exposure-过曝，unknown-未知状态
13）	+expiryDate	有效日期（仅ocrType为1时返回）
14）	+issuingAuthority	签发机关（仅ocrType为1时返回）
15）	+cardNum	身份证编号（仅ocrType为0时返回）
16）	+name	身份证上姓名（仅ocrType为0时返回）
17）	+direction	图像方向 -1-未定义，0-正向，1-逆时针90度，2-逆时针180度，3-逆时针270度
18）	+riskType	身份证风险类型，输入参数detect_risk=true时，则返回该字段识别身份证类型，normal-正常身份证，copy-复印件

3.1.5.2. 响应成功参数示例

{

"code": 200,

"msg": "成功",

"success": true,

"data": {

"tradeNo":"交易流水号"

"address":"地址"

"birth":"出生日期"

"name":"姓名"

"cardNum":"身份证编号"

"sex":"性别"

"nation":"民族"

"imageStatus":"图像状态"

"riskType":"身份证风险类型"

"direction":"图像方向"

}

3.1.5.3. 结果码说明

结果码	描述
200	成功
500，501，503	系统错误
502	系统繁忙
60021	余额不足，请充值后重试！
10000	内部系统出错，请联系厂商