身份证OCR接口文档

---

1.接口说明

名称	说明
协议	HTTPS POST
地址	https://api.cxlnk.com/api/idCardOcr
Accept	application/json
Content-Type	application/json;charset=utf-8

2.请求参数说明

响应 body 数据为 JSON 格式

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

3.请求参数示例

{
 "accessKey": "NDYw*******",
 "accessSecret": "MDQyOTQ1OTM3*********************",
 "imageType":"BASE64",
 "image":"DAQL/xAA+EAACAgEEAAUCAwYD***************",
 "ocrType":"0",
 "detectRisk":"false"
}

4.响应参数列表

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

5.响应参数示例

{
 "code": 200,
 "msg": "成功",
 "success": true,
 "data":{
	     "tradeNo":"交易流水号",
		 "address":"地址",
		 "birth":"出生日期",
		 "name":"姓名",
		 "cardNum":"身份证编号",
		 "sex":"性别",
		 "nation":"民族",
		 "imageStatus":"图像状态",
		 "riskType":"身份证风险类型",
		 "direction":"图像方向"
    }
}
						

6.结果码说明

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