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

zhima.customer.certification.material.certify (芝麻认证材料认证)

传入用户身份信息和认证材料做认证

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 zhima.customer.certification.material.certify
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
transaction_id String 必须 32 商户请求的唯一标志,商户要保证其唯一性。值为32位长度的字母数字下划线组合。建议:前面几位字符是商户自定义的简称,中间可以使用一段日期,结尾可以使用一个序列 ZGYD201610252323000001234
product_code String 必须 32 芝麻认证产品码,示例值为真实的产品码 w1010100000000002978
biz_code String 必须 32 认证场景码,常用的场景码有:FACE_API,入参支持的认证场景码和商户签约的认证场景相关,详见芝麻认证快速接入文档 FACE_API
identity_param String 必须 204800 "identity_type":”CERT_INFO”,是指入参类型为证件信息。芝麻认证有很多认证场景(biz_code),不同认证认证场景(biz_code)支持的入参类型不同,详细请见芝麻认证快速接入文档里面的表格 {"identity_type": "CERT_INFO", "cert_type": "IDENTITY_CARD", "cert_name": "收委", "cert_no": "260104197909275964"}
materials String 必须 204800 认证过程中需要的认证材料,不同认证场景需要的材料不同,biz_code值为FACE_API时需要材料FACIAL_PICTURE_FRONT {"FACIAL_PICTURE_FRONT": "/9j/4AAQSkZJR"}
merchant_config String 可选 1024 商户可选的一些设置 {}
ext_biz_param String 可选 2048 扩展业务参数,暂时没有用到,接口预留 {}
linked_merchant_id String 可选 16 芝麻平台服务商模式下的二级商户标识,如果是直连商户调用该接口,不需要设置 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 本次认证的唯一标识,商户需要记录,后续的操作都需要用到 ZM201612013000000393900404029253
passed String 必填 16 认证是否通过,通过为true,不通过为false true
failed_reason String 必填 256 认证不通过的原因 认证完成

请求示例

  • 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");
ZhimaCustomerCertificationMaterialCertifyRequest request = new ZhimaCustomerCertificationMaterialCertifyRequest();
request.setBizContent("{" +
"\"transaction_id\":\"ZGYD201610252323000001234\"," +
"\"product_code\":\"w1010100000000002978\"," +
"\"biz_code\":\"FACE_API\"," +
"\"identity_param\":\"{\\\"identity_type\\\": \\\"CERT_INFO\\\", \\\"cert_type\\\": \\\"IDENTITY_CARD\\\", \\\"cert_name\\\": \\\"收委\\\", \\\"cert_no\\\": \\\"260104197909275964\\\"}\"," +
"\"materials\":\"{\\\"FACIAL_PICTURE_FRONT\\\": \\\"/9j/4AAQSkZJR\\\"}\"," +
"\"merchant_config\":\"{}\"," +
"\"ext_biz_param\":\"{}\"," +
"\"linked_merchant_id\":\"2088721630869411\"" +
"  }");
ZhimaCustomerCertificationMaterialCertifyResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"zhima_customer_certification_material_certify_response":{
		"msg":"Success",
		"code":"10000",
		"biz_no":"ZM201612013000000393900404029253",
		"passed":"true",
		"failed_reason":"认证完成"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 系统繁忙,请稍后再试
INVALID_PARAMETER 参数有误 根据错误码描述修改入参后再重试
BIZ_ERROR 业务异常,认证失败 请根据错误码描述检查错误原因
ARRANGEMENT_ERROR 合约异常 请确定的产品码正确,合约已经生效,并且包含此业务的权限
TRANSACTION_ERROR 交易订单异常 交易订单更新失败,请稍后重新发起
UNSUPPORTED_BIZ_CODE 不支持的认证场景 请使用已签约的认证场景

公共错误码

返回
顶部