服务说明
1) 服务适用场景
用户准入阶段的信息录入识别,对合作伙伴后期业务的健康快速发展起着重要的作用,OCR证照识别技术会有效提升合作伙伴准入审核效率。
2) 服务调用方式
环境 |
HTTPS请求地址 |
正式环境 |
https://openapi.alipay.com/gateway.do |
3) 申请前准备工作
有效的APPID:您需提供一个有效的应用ID(APPID)来调用此服务,您可前往
https://openhome.alipay.com/platform/appManage.htm#/apps生成一个专属应用,或使用现有的APPID来申请此服务。
接口说明
接口名:alipay.security.risk.customerrisk.query
公共请求参数(支付宝sdk已封装)
参数名 |
类型 |
是否必填 |
描述 |
示例值 |
app_id |
String |
是 |
支付宝分配给开发者的应用id |
2014072300007148 |
method |
String |
是 |
接口名称 |
alipay.security.risk.customerrisk.query |
format |
String |
否 |
仅支持json |
JSON |
charset |
String |
是 |
请求使用的编码格式 |
utf-8 |
sign_type |
String |
是 |
商户生成签名字符串所使用的签名算法,目前支持RSA2和RSA,推荐使用RSA2 |
RSA2 |
sign |
String |
是 |
商户请求参数的签名串,详见签名 |
详见链接 |
timestamp |
String |
是 |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
2018-05-15 07:15:00 |
version |
String |
是 |
调用的接口版本号,固定为1.0 |
1.0 |
app_auth_token |
String |
否 |
详见链接:第三方应用授权 |
|
biz_content |
String |
是 |
请求参数的集合,最大长度不限,除公共参数外,其他所有请求参数都必须放在这个参数中传递 |
|
请求参数(需要调用方传递)
参数 |
类型 |
是否必须 |
最大长度 |
描述 |
示例值 |
service |
String |
是 |
128 |
服务类型 |
固定传ocr |
cert_type |
String |
是 |
64 |
证照类型,例如: BUSINESS_LICENSE:营业执照 IDCARD:身份证 BANK_CARD:银行卡 |
BUSINESS_LICENSE |
side |
String |
否 |
64 |
身份证正反面标识; 枚举值: front:正面(人像侧) back:反面(国徽侧) 除身份证外,其余证件类型不需要传此字段 |
front |
img_content |
String |
是 |
~ |
待识别图片,需转成base64编码 |
|
apply_id |
String |
否 |
128 |
可选参数,查询任务唯一标识(需用户自行保证唯一性),可用于历史识别任务结果查询;不同图片不能使用同一apply_id |
|
公共响应参数
参数 |
类型 |
是否必须 |
最大长度 |
描述 |
示例值 |
code |
String |
是 |
~ |
网关返回码, |
40004 |
msg |
String |
是 |
~ |
网关返回码描述 |
Business Failed |
sub_code |
String |
否 |
~ |
网关明细返回码, |
isv.invalid-signature |
sub_msg |
String |
否 |
~ |
网关明细返回码描述, |
交易已被支付 |
sign |
String |
是 |
64 |
签名 |
|
业务返回参数
参数 |
类型 |
是否必填 |
最大长度 |
描述 |
示例值 |
risk_result |
String |
是 |
128 |
图片信息识别结果 |
\"number\":\"*****\",\"address\":\"浙江省杭州市西湖区天目山路88号\",\"race\":\"汉\",\"sex\":\"男\",\"name\":\"张三\",\"birth\":\"19740914\" |
代码示例
请求示例
身份证
正面
{ "biz_content": { "service": "ocr", "cert_type": "IDCARD", "side": "front", "img_content": "**证件照片base64格式**" } }
反面
{ "biz_content": { "service": "ocr", "cert_type": "IDCARD", "side": "back", "img_content": "**证件照片base64格式**" } }
银行卡
{ "biz_content": { "service": "ocr", "cert_type": "BANK_CARD", "img_content": "**证件照片base64格式**" } }
响应示例
1,正常返回
{"alipay_security_risk_customerrisk_query_response":{"code":"10000","msg":"Success","risk_result":"{\"number\":\"*****\",\"address\":\"浙江省杭州市西湖区天目山路88号\",\"race\":\"汉\",\"sex\":\"男\",\"name\":\"***\",\"birth\":\"19740914\"}"},"sign":"hUcd1wz2RZJJ3lFg4onWUlj+lY+hG68VNA+xGB5GbHZDm6Z5MIzCM+O+v5ZIGFCo7RK7RgXCz0pMk5i6Z2R8392URJ7Dt4f3TF3RdQpgBUJ0vjr9Qb+1LYuJ41HJIU/oZBrjZUZ7L73Z+fI/rAqKvMmEUoXU3BpPfm0aAsXrqg20Ecf9rP76g2k0YRweXEVFcNTa9ozna3JbdAJhC9kya2Hnd7yCvbGnzXn6QnNkrjnO9Yr7XBBjiwBOpCdVDYJp4mctnpQHChy4MfSarAoHQ9zM6k9WLXrCpjU/HX2GsEmj/80zzutTkPoSh9lot52As7ge0ihA/VS9/wokg4u0sA=="}
业务错误码
错误码 |
错误描述 |
解决方案 |
BIZ_ERROR |
业务异常服务没有被授权,比如虽然已经签约query服务,但是没有被授权查询商户综合风险,出这个异常 |
联系商户服务团队,在服务申请页面中申请此细项服务的授权 |
INVALID_PARAMETER |
参数有误没有按照要求进行参,比如要求mobile_no,但是输入了mobile |
请查看接口文档,查看参数是否正确配置 |
SYSTEM_ERROR |
系统繁忙 |
系统分析超时,请先检查是否图片过大,本API限制图片大小不超过1M。 |
MISSING_REQUIRED_ARGUMENTS |
参数有误缺少必选参数 |
请查看接口文档,查看参数是否配置正确。 |
注意事项