文档中心 > API类目 > 芝麻信用API

zhima.credit.relation.query (联系人验证)

金融机构在信贷业务中一般会要求用户提供1~2个联系人信息,用于贷前核验用户信息的真实性,贷后用户发生逾期之后也可用于催收,该产品用于对用户的联系人信息进行核验

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 zhima.credit.relation.query
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 256 商户请求参数的签名串,详见签名 详见示例
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
product_code String 必须 32 产品码,标记商户接入的具体产品;直接使用每个接口入参中示例值即可 w1010100001000001200
transaction_id String 必须 64 商户请求的唯一标志,长度64位以内字符串,仅限字母数字下划线组合。该标识作为业务调用的唯一标识,商户要保证其业务唯一性,使用相同transaction_id的查询,芝麻在一段时间内(一般为1天)返回首次查询结果,超过有效期的查询即为无效并返回异常,有效期内的重复查询不重新计费 20151127233347987676212309253
cert_no String 必须 18 申请人证件号,中国大陆18或者15位合法身份号 640202199007164686
name String 必须 64 申请人证件姓名,简体中文,长度不超过64,姓名中不含",","/u0001","|","&","^","\\"等特殊字符 张三
relation_phone String 必须 24 手机号码。中国大陆合法手机号,长度11位,不含国家代码 15843991158
relation_name String 必须 64 联系人姓名,简体中文,长度不超过64,姓名中不含",","/u0001","|","&","^","\\"等特殊字符 李四
relation String 可选 12 申请人与联系人之间关系类型,目前支持4类关系,family(亲友)、workmate(同事)、schoolmate(同学)、friend(朋友) family
linked_merchant_id String 可选 32 芝麻平台服务商模式下的二级商户标识,如果是直连商户调用该接口,不需要设置 2088721630869411

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
biz_no String 必填 32 芝麻信用对于每一次请求返回的业务号。后续可以通过此业务号进行对账 ZM201608223000000242400084180839
relation_rank String 必填 24 关系强度,具体关系强度code见产品文档 V_CT_RL_SG
relation_info RelationInfo 选填 24 对关系的具体描述,只有存在关系时才能输出
  • └ recency
  • String
  • 必填
  • 20
  • 关系新鲜度,如V_CT_RL30D(最近30天有联系)详细描述见产品文档。
  • V_CT_RL180D
relation_score Number 选填 2 0~100整数,分数越高与输入关系越匹配度越高,如果入参无relation,则该值为0 99

请求示例

  • 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");
ZhimaCreditRelationQueryRequest request = new ZhimaCreditRelationQueryRequest();
request.setBizContent("{" +
"\"product_code\":\"w1010100001000001200\"," +
"\"transaction_id\":\"20151127233347987676212309253\"," +
"\"cert_no\":\"640202199007164686\"," +
"\"name\":\"张三\"," +
"\"relation_phone\":\"15843991158\"," +
"\"relation_name\":\"李四\"," +
"\"relation\":\"family\"," +
"\"linked_merchant_id\":\"2088721630869411\"" +
"}");
ZhimaCreditRelationQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"zhima_credit_relation_query_response":{
		"msg":"Success",
		"relation_info":{
			"recency":"V_CT_RL180D"
		},
		"code":"10000",
		"biz_no":"ZM201608223000000242400084180839",
		"relation_score":99,
		"relation_rank":"V_CT_RL_SG"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
API_PRODUCT_NOT_MATCH 输入的产品码不正确 按照接口文档传入正确的产品码
INVALID_TRANSACTION_ID 业务流水号不正确 传入transaction_id字段,支持字母、数字、下划线
NO_VALID_ARRANGEMENT 无有效合约 完成产品签约
INVALID_PARAMETER 参数有误 按照错误提示修改合法的接口参数
PRODUCT_CODE_IS_NULL 产品码为空 请输入产品码
SYSTEM_ERROR 系统繁忙 重试或反馈芝麻信用技术支持
TRANSACTION_ID_EXPIRED 业务流水号已过期 请传入正确的业务流水号
TRANSACTION_ID_REPEAT 相同业务流水号但业务参数不一致,无法提供服务 每个请求请生成唯一的业务流水号transaction_id

公共错误码

返回
顶部