1.0-通联
1.1 批量新增用户信息
1.1.1 简要描述
批量新增用户信息
1.1.2 请求 URL
/regulator/openapi/v3/user_info/batch_create
请求方式
- POST
返回类型
- JSON
1.1.3 请求参数
传入用户信息列表,用户信息参数如下
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
realName | String | Y | 真实姓名 | |
phone | String | Y | 手机号 | |
cardNo | String | Y | 身份证 | |
bankCardNo | String | Y | 银行卡号 | |
idCardFront | String | Y | 身份证正面地址 | 源⽂件必须为图片格式,照⽚宽和⾼必须⼤于100px,⼩于2000px,照⽚的⼤⼩不超过 3M; |
idCardBack | String | Y | 身份证反面地址 | 源⽂件必须为图片格式,照⽚宽和⾼必须⼤于100px,⼩于2000px,照⽚的⼤⼩不超过 3M; |
facePhoto | String | Y | 人像照片地址 | 源⽂件必须为图片格式,照⽚宽和⾼必须⼤于100px,⼩于2000px,照⽚的⼤⼩不超过 3M; |
contractUrl | String | Y | 合同地址 | pdf 格式 |
1.1.4 返回参数(JSON)
返回数据明细(data)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
userCode | String | 用户编码 | |
realName | String | 真实姓名 | |
phone | String | 手机号 | |
cardNo | String | 身份证 | |
bankCardNo | String | 银行卡号 | |
idCardFront | String | 身份证正面地址 | |
idCardBack | String | 身份证反面地址 | |
facePhoto | String | 人像照片地址 | |
contractUrl | String | 合同地址 | |
errorMsg | String | 错误信息 |
1.1.5 接口请求示例
[
{
"realName": "雷小平",
"phone": "13221719843",
"cardNo": "500101197805272006",
"bankCardNo": "4027915592223580",
"idCardFront": "https://js.alitatest.cn/anon/file/download/76c031a1a0f84dc0900991c07cafa80e",
"idCardBack": "https://js.alitatest.cn/anon/file/download/461b00ba49ac41149c1ce32460e59fa3",
"facePhoto": "https://js.alitatest.cn/anon/file/download/ce2d43d345064fc7b9bb8c93e3ca24b5",
"contractUrl": "https://huluwa-ec.oss-accelerate.aliyuncs.com/20200827/20200827103002_4590.pdf"
}
]
1.1.6 接口成功返回示例
{
"requestId": "136632bfe6ab5b65",
"msg": "请求成功",
"code": "200",
"success": true,
"data": [
{
"userCode": "UIF20211228001006",
"realName": "雷小平",
"phone": "13221719843",
"cardNo": "500101197805272006",
"bankCardNo": "4027915592223580",
"idCardFront": "https://js.alitatest.cn/anon/file/download/76c031a1a0f84dc0900991c07cafa80e",
"idCardBack": "https://js.alitatest.cn/anon/file/download/461b00ba49ac41149c1ce32460e59fa3",
"facePhoto": "https://js.alitatest.cn/anon/file/download/ce2d43d345064fc7b9bb8c93e3ca24b5",
"contractUrl": "https://huluwa-ec.oss-accelerate.aliyuncs.com/20200827/20200827103002_4590.pdf",
"errorMsg": null
}
],
"errorData": null
}
1.1.7 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码
1.2 用户列表查询(分页)
1.2.1 简要描述
分页查询用户列表
1.2.2 请求 URL
/regulator/openapi/v3/user_info/page
请求方式
- GET
返回类型
- JSON
1.2.3 请求参数(GET)
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
pageNo | Integer | N | 页码 | 默认 1 |
pageSize | Integer | N | 页数 | 默认 20 |
userCode | String | N | 用户编码 | |
phone | String | N | 手机号 | |
cardNo | String | N | 身份证 | |
realName | String | N | 真实姓名 | 模糊匹配 |
1.2.4 返回参数(JSON)
返回数据明细(data)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
userCode | String | 用户编码 | |
realName | String | 真实姓名 | |
phone | String | 手机号 | |
cardNo | String | 身份证 | |
bankCardNo | String | 银行卡号 | |
idCardFront | String | 身份证正面地址 | |
idCardBack | String | 身份证反面地址 | |
facePhoto | String | 人像照片地址 | |
contractUrl | String | 合同地址 | |
busiStatus | Integer | 业务状态 | 1: 新建 2:处理中 3:处理成功 4:处理失败 |
errorMsg | String | 错误信息 |
1.2.5 接口成功返回示例
无参数
{
"requestId": "2802f285022927a9",
"msg": "请求成功",
"code": "200",
"success": true,
"data": {
"pageNo": 1,
"pageSize": 20,
"pageCount": 1,
"totalCount": 1,
"entityList": [
{
"userCode": "UIF20211228001006",
"realName": "雷小平",
"phone": "13221719843",
"cardNo": "500101197805272006",
"bankCardNo": "4027915592223580",
"idCardFront": "https://js.alitatest.cn/anon/file/download/76c031a1a0f84dc0900991c07cafa80e",
"idCardBack": "https://js.alitatest.cn/anon/file/download/461b00ba49ac41149c1ce32460e59fa3",
"facePhoto": "https://js.alitatest.cn/anon/file/download/ce2d43d345064fc7b9bb8c93e3ca24b5",
"contractUrl": "https://huluwa-ec.oss-accelerate.aliyuncs.com/20200827/20200827103002_4590.pdf",
"busiStatus": 3,
"errorMsg": ""
}
],
"firstEntityIndex": 0,
"needPage": true
},
"errorData": null
}
1.2.6 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码
1.3 推送结果 URL(提前提供给我方,需支持 post 请求)
用户执行完毕会第一时间推送数据到给定的URL返回数据在body中。 返回我方数据 code=200 代表接收成功,如失败,将再次推送最多3次。 接入方根据返回的userCode 调用:1.2用户列表查询(分页)接口查询完整结果。
1.2.5 接口推送示例
{
"appNo": "xxxx",
"callbackType": 3,
"data": {
"userCode": "UIF20211228001006"
}
}
1.2.6 响应示例
{
"requestId": "2802f285022927a9",
"msg": "请求成功",
"code": "200",
"success": true,
"data": null,
"errorData": null
}