身份证OCR识别下单
1.修订记录
修订 |
日期 |
说明 |
作者 |
V0.1 |
2019/10/11 |
新接口参数定义 |
宁华雄 |
V0.2 |
2021/12/23 |
新增cert_type入参 |
王晶 |
V0.3 |
2021/12/27 |
支持国密 |
王晶 |
2.接口说明
(1)场景说明
1、身份证OCR识别下单
(2)接口说明
1、 身份证OCR识别下单接口
3.请求地址
4.请求参数说明
4.1 公共请求参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
method |
String(1,128) |
Y |
接口名称。示例值:ysepay.authenticate.ocr.idcard |
partner_id |
String(1,20) |
Y |
商户在银盛支付平台开设的用户号[商户号] |
timestamp |
String(1,19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss",示例值:2014-07-24 03:07:50 |
charset |
String(1,10) |
Y |
商户网站使用的编码格式,如utf-8、gbk、gb2312等。示例值:GBK |
sign_type |
String(1,10) |
Y |
签名类型,RSA/SM |
sign |
String(1,256) |
Y |
签名字符串,再用Base64编码 |
version |
String(1,3) |
Y |
接口版本,示例值:3.0 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号,生成规则前8位必须为交易日期,如20180525,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成,示例值:201805256843192280647118 |
shopdate |
String(8,8) |
Y |
商户日期(该参数做交易与查询时需要一致) 该日期需在当日的前后一天时间范围之内 |
token |
String |
Y |
身份证照片(正面或反面)的token值(上传口令) ,调用接口获取token值后,根据token上传图片一个token只上传一张图片具体请查看 2节 图片上传流程 |
cert_type |
String(2,2) |
N |
认证类型:00:大陆身份证, 01:香港身份证;02:澳门身份证,03:台湾身份证,不传默认为00 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_authenticate_ocr_idcard_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期对返回参数保留扩展的权利,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号 |
trade_no |
String(16) |
N |
交易流水 |
fee |
Number(15) |
N |
参考手续费,单位为:RMB Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
order_status |
String(32) |
Y |
OCR识别结果状态。状态的值: SUCCESS/FAILURE具体详情看下文中的1.4、OCR识别状态详解 |
response_code |
String(6) |
N |
响应代码 |
response_note |
String(100) |
N |
响应描述 |
result_info |
|
N |
结果集 |
5.1 result_info 结果集
参数 |
类型(字节长度) |
必填 |
参数说明 |
name |
String(1,19) |
N |
姓名 |
first_name |
String |
N |
名 |
last_name |
String |
N |
姓 |
english_name |
String |
N |
英文名 |
name_code |
String |
N |
姓名代码 |
sex |
String(1,5) |
N |
性别 |
nation |
String(1,5) |
N |
民族 |
year |
String(1,5) |
N |
出生年 |
month |
String(1,5) |
N |
出生月 |
day |
String(1,5) |
N |
出生日 |
address |
String(1,100) |
N |
地址 |
cidno |
String(1,100) |
N |
身份证卡号 |
authority |
String(1,100) |
N |
签发机关 |
expire_date |
String(1,10) |
N |
身份证有效期 |
6.样例
无
7.附录
7.1 业务错误码
错误码 |
错误描述 |
解决方案 |
AQC.SYSTEM_ERROR |
系统错误 |
请调用查询接口查询订单状态 |
ACQ.INVALID_PARAMETER |
参数无效 |
检查请求参数,修改后重新发起请求 |
ACQ.PARAM_ERROR |
参数错误 |
检查请求参数,修改后重新发起请求 |
ACQ.RISK_ERROR |
风控检查异常 |
请检查风控是否有异常,然后再重新发起 |
ACQ.SYSTEM_BUSY |
系统繁忙 |
请稍后再试,如还有问题,请联系银盛 |
ACQ.RETURN_ERROR |
OCR识别回执异常 |
请稍后再试,如还有问题,请联系银盛 |
ACQ.PICTRUE_NULL_ERROR |
通过TOKEN获取图片失败 |
请检查TOKEN是否上传了图片、图片上传的类型是否正确 |
7.2 实名认证状态
枚举名称 |
枚举说明 |
SUCCESS |
实名认证成功 |
FAILURE |
实名认证失败 |