OCR-身份证识别
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2024.03.01 | 初版 |
2、业务说明
（1）接口说明
身份证识别
请求主体类型：application/json
请求方式：POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay.com/openapi/pregate/auth/idCardOcr |
| 正式环境 | https://ysgate.ysepay.com/openapi/pregate/auth/idCardOcr |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称，固定值：pregate.auth.idCardOcr |
| charset | String(10) | Y | 请求使用的编码格式，如utf-8,gbk,gb2312等,固定为utf-8 |
| sign | String | Y | 商户请求参数的签名串（签名算法默认为国密）,详见demo,注意:请用商户私钥进行签名 |
| check | String | Y | 银盛公钥加密随机生成的字符串（key）得到的加密值，详见demo |
| bizContent | String | Y | 业务参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递。注意：需要通过AES以及随机生成的字符串（key）加密业务参数集合，得到bizContent |
| reqId | String | Y | 请求唯一流水号,商户系统唯一，要求32个字符内（最少14个字符），只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值：xy1415220315145602 |
| certId | String | Y | 发起方商户号，服务商在银盛给自己开设的商户号，即可当作发起方商户号，由银盛生成并下发。 注意：不同于子商户号，服务商发展的商户即为子商户号 |
| version | String | Y | 调用的接口版本，固定为：1.0 |
4.2、业务请求参数
（bizContent加密前的json数据明文字符串）
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| idCardFrontPic | String | Y | 身份证正面照片和反面照都支持,base编码 |
| certType | String | N | 证件类型,为空或者00:大陆身份证， 01:香港身份证；02:澳门身份证，03：台湾身份证 |
5、响应参数说明
请注意：银盛后期会对返回参数保留扩展的权力，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。5.1、公共响应参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| code | String(5) | Y | 网关响应码，示例值：00000 ，详见网关公共响应码 |
| msg | String(50) | Y | 网关响应码描述 |
| subCode | String | Y | 业务响应码，参见具体的API接口文档 |
| subMsg | String | Y | 业务响应描述 |
| timeStamp | String | Y | 响应时间，格式"yyyy-MM-dd HH:mm:ss" |
| norce | String(128) | Y | 随机参数 |
| sign | String | Y | 响应参数的签名串，详见demo, 注意:请用银盛公钥进行验签 |
| businessData | String | Y | 业务响应参数集合， 注意：银盛网关通过AES加密业务响应参数集合，得到businessData，商户需要对其进行解密，详情请见demo |
5.2、业务响应参数
响应业务参数businessData(json数据)
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| orderId | String | N | 订单号 |
| tradesn | String | N | 交易流水号 |
| idCardInfo | Object | N | 身份证信息,成功时返回 |
| idCardValidity | Object | N | 身份证验证信息 |
5.2.1 idCardInfo具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| name | String | N | 姓名 |
| sex | String | N | 性别 |
| nation | String | N | 民族 |
| year | String | N | 出生年 |
| month | String | N | 出生月 |
| day | String | N | 出生日 |
| address | String | N | 住所 |
| cidNo | String | N | 身份证号码 |
| authority | String | N | 签发机关 |
| timeLimit | String | N | 身份证有效期 |
5.2.2 idCardValidity具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| name | String | N | 姓名,如果小于两个字符，或者包含数字，为 false，反之为 true |
| sex | String | N | 性别,当检测出的性别与身份证号所表示的性别匹配，则为 true，反之为 false |
| birthday | String | N | 生日,当检测出的出生日期与身份证号中的生日字段匹配，则值为 true，反之为 false |
| address | String | N | 地区码,身份证号码前6位为地区码，当其在预设的码表内，则值为 true，否则为 false |
| cidNo | String | N | 身份证号码,当身份证号码符合校验规则，则值为 true，反之，为 false |
| authority | String | N | 签发机关,检测出签发机构后两字是“分局”或“安局”，则为 true，否则为 false |
| timeLimit | String | N | 身份证有效期,身份证有效期长度为 17 位，第八位为 -，年份大于等于 2000 年且小于等于 2050 年时，该值为 true，否则为 false |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 0000 | 成功 | |
| 9999 | 失败 | 系统异常，请稍后使用相同的参数继续调用 |
| 5000 | 超时 | 业务系统超时，请稍后使用相同的参数继续调用 |
| A029998 | 非法参数 | 请根据接口返回的详细信息检查请求参数 |