alipay.user.certdoc.sync (会员电子证件信息保存)

配合支付宝授权服务,将外部证件信息同步到支付宝卡包证件夹。

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
cert_type String 必须 180 IDENTITY_CARD:身份证;
DRIVING_LICENSE:驾驶证;
VEHICLE_LICENSE:行驶证;
SOCIAL_SECURITY_CARD:社会保障卡;
PASSPORT:护照;
DEGREE_CERTIFICATE:学位证;
HK_MACAU_LAISSEZ_PASSER:港澳通行证;
PROPRETY_OWNERSHIP_CERTIFICATE:房产证;
REAL_ESTATE_WARRANTS:不动产证;
DRIVING_LICENSE
cert_no String 必须 30 证件号 230100199901010001
user_id String 必须 16 蚂蚁统一会员ID 2088302199778310
name String 必须 30 证件主体用户姓名。证件类型+证件号+证件姓名需要唯一。 张三
ext_info String 必须 3000 证件其余信息,以json string形式传入。具体每一个k/v规则参照具体证件规则。举例驾驶证extInfo规则:
字段名字(key):drivingLicenseNo,字段含义:证号,字段类型:STRING,是否可空:否;
字段名字(key):sex,字段含义:性别,字段类型:STRING,是否可空:是,值非空时约束:选择,具体约束:男,女,;
字段名字(key):nationality,字段含义:国籍,字段类型:STRING,是否可空:是;
字段名字(key):address,字段含义:住址,字段类型:STRING,是否可空:是;
字段名字(key):dateOfBirth,字段含义:出生日期,字段类型:DATE,是否可空:是;
字段名字(key):dateOfFirstIssue,字段含义:初次领证日期,字段类型:DATE,是否可空:是;
字段名字(key):clazz,字段含义:准驾车型,字段类型:STRING,是否可空:是,值非空时约束:正则表达式,具体约束:^[a-z_A-Z_0-9]*$;
字段名字(key):fileNo,字段含义:档案编号,字段类型:STRING,是否可空:是,值非空时约束:正则表达式,具体约束:^[0-9]{12}$;
字段名字(key):issuingAuthority,字段含义:签发机关,字段类型:STRING,是否可空:是;
字段名字(key):valideDate,字段含义:生效日期,字段类型:DATE,是否可空:是,值非空时约束:正则表达式,具体约束:^\d{4}-\d{2}-\d{2}$;
字段名字(key):expireDate,字段含义:失效日期,字段类型:DATE,是否可空:是,值非空时约束:正则表达式,具体约束:^\d{4}-\d{2}-\d{2}$;
{"expireDate":"2017-11-21","fileNo":"330000380457","drivingLicenseNo":"230100199901010001"}
pic_list OpenCertPic [] 可选 - 证件图片集合
  • └ type
  • String
  • 必填
  • 100
  • DRIVING_LICENSE_HOME_PAGE:主页;
    DRIVING_LICENSE_SUB_PAGE:副页;
  • DRIVING_LICENSE_HOME_PAGE
  • └ data
  • String
  • 必填
  • 5000000
  • 图片的base64字符串,不需要base64头(data:image/jpeg;base64,)
  • -

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值

请求示例

  • 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");
AlipayUserCertdocSyncRequest request = new AlipayUserCertdocSyncRequest();
request.setBizContent("{" +
"\"cert_type\":\"DRIVING_LICENSE\"," +
"\"cert_no\":\"230100199901010001\"," +
"\"user_id\":\"2088302199778310\"," +
"\"name\":\"张三\"," +
"\"ext_info\":\"{\\\"expireDate\\\":\\\"2017-11-21\\\",\\\"fileNo\\\":\\\"330000380457\\\",\\\"drivingLicenseNo\\\":\\\"230100199901010001\\\"}\"," +
"\"pic_list\":[{" +
"\"type\":\"DRIVING_LICENSE_HOME_PAGE\"," +
"\"data\":\"-\"" +
"}]" +
"}");
AlipayUserCertdocSyncResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_user_certdoc_sync_response":{
		"msg":"Success",
		"code":"10000"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 系统繁忙,稍后重试
ILLEGAL_PERMISSION 业务异常,检查appId是否有指定证件类型的写入权限 检查appId是否有指定证件类型的写入权限
ILLEGAL_ARGUMENT 参数有误,入参有空 检查证件类型、证件号、用户id、姓名、ext_info参数是否为空
ILLEGAL_FIELD extInfo中参数有误 检查ext_info中的key和value是否正确

公共错误码

返回
顶部