文档中心 > API类目 > 工具类API

alipay.security.risk.verifyidentity.apply (核身可用性查询接口)

用于核身产品是否可用的前置查询

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.security.risk.verifyidentity.apply
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
biz_id String 必须 128 接入业务方业务唯一性id test_302857831249
account_name String 可选 128 用户姓名 张三
account_id String 必须 128 用户帐号 330102198807312189
account_type String 可选 32 帐号类型:ALIPAY_USERID,CERT ALIPAY_USERID
validate_product_group String 必须 10000 待校验的核身产品集合 {"id":1,"name":"NATIVE_PAYMENT_PASSWORD","uuid":"2ac7745f2151420ea168476b0675010a"}
scene_code String 必须 128 身份核验场景CODE,商务谈判基础上,由支付宝来分配。 metro#metro#metro_forgetpwd_confirm#mobileClient
biz_params String 可选 5000 业务信息上下文,JSON结构 {"sms_code":"test","qrcode_expired_time":604800}

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
is_success String 必填 8 系统是否处理成功,true表示系统成功处理,false表示系统异常,系统处理成功不表示业务成功 false
err_code String 必填 32 可用性查询失败错误码 SYSTEM_ERROR
err_message String 必填 64 核身可用性查询错误描述 系统错误
usable_product_group String 必填 10000 可用产品集合 {"id":1,"name":"NATIVE_PAYMENT_PASSWORD"}
unusable_product_list String 必填 10000 不可用产品集合 {"id":1,"name":"FACE"}

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipaySecurityRiskVerifyidentityApplyRequest request = new AlipaySecurityRiskVerifyidentityApplyRequest();
request.setBizContent("{" +
"\"biz_id\":\"test_302857831249\"," +
"\"account_name\":\"张三\"," +
"\"account_id\":\"330102198807312189\"," +
"\"account_type\":\"ALIPAY_USERID\"," +
"\"validate_product_group\":\"{\\\"id\\\":1,\\\"name\\\":\\\"NATIVE_PAYMENT_PASSWORD\\\",\\\"uuid\\\":\\\"2ac7745f2151420ea168476b0675010a\\\"}\"," +
"\"scene_code\":\"metro#metro#metro_forgetpwd_confirm#mobileClient\"," +
"\"biz_params\":\"{\\\"sms_code\\\":\\\"test\\\",\\\"qrcode_expired_time\\\":604800}\"" +
"  }");
AlipaySecurityRiskVerifyidentityApplyResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_security_risk_verifyidentity_apply_response":{
		"msg":"Success",
		"usable_product_group":"{\"id\":1,\"name\":\"NATIVE_PAYMENT_PASSWORD\"}",
		"code":"10000",
		"err_code":"SYSTEM_ERROR",
		"is_success":"false",
		"err_message":"系统错误",
		"unusable_product_list":"{\"id\":1,\"name\":\"FACE\"}"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

  • JSON示例
{
	"alipay_security_risk_verifyidentity_apply_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 系统异常,建议稍后重试或联系技术支持人员解决
USABLE_QUERY_FAIL 参数biz_id为空 调整参数,重试
USABLE_QUERY_FAIL 参数account_id为空 调整参数,重试
USABLE_QUERY_FAIL 参数validate_product_group为空 调整参数,重试
USABLE_QUERY_FAIL 参数scene_code为空 调整参数,重试
USABLE_QUERY_FAIL 参数validate_product_group包含的产品参数错误 修改产品名称,重试

公共错误码

返回
顶部