创建钱包用户 - 帮助文档

请求参数

Header 参数

Content-Type

string

必需

固定值：application/json

X-Api-Key

string

必需

项目 API Key，用于 API 访问鉴权

X-Timestamp

string

必需

时间戳，1970年1月1日0点0分0秒到现在的毫秒数

X-Signature

string

必需

API 签名，算法为SHA256(Params+Timestamp+ApiSecret)

Body 参数application/json

user_type

enum<integer>

用户类型，对应创建的钱包用户的类型属性

可选

默认值为0(普通用户)、1(个人用户)、2(企业/机构用户)

枚举值:

012

默认值:

0

phone_num

string

手机号

必需

创建普通用户需要填入的参数，当 user_type 为 0 时，必需填入该字段。7-12 位纯数字，不支持座机类型。

>= 7 字符<= 12 字符

individual

object

个人用户信息

可选

创建个人用户需要填入的参数，当 user_type 为 1 时，请根据 individual下的参数进行参数提交。
📢注意：individual 只作为展示的 Key，实际上只需要入参 individual 下的参数即可

name

string

用户的真实姓名

必需

支持汉字以及大小写字母、空格

<= 32 字符

region

enum<integer>

所属国家/地区

可选

1：其他 2：中国大陆（默认） 3：中国香港 4：中国台湾

枚举值:

1234

certificate_type

enum<integer>

用户证件类型

可选

1：身份证（默认） 2：护照

枚举值:

12

certificate_num

string

用户证件号码

必需

24位数字+大写字母

<= 24 字符

phone_num

string

联系人或授权人手机号

必需

7-12 位纯数字，

>= 7 字符<= 12 字符

enterprise

object

企业/机构用户信息

可选

创建企业/机构用户需要填入的参数，当 user_type 为 2 时，请根据 enterprise 下的参数进行参数提交。
📢注意：enterprise 只作为展示的 Key，实际上只需要入参 enterprise 下的参数即可

name

string

企业的名称

必需

最大长度64位，支持汉字、大小写字母、数字和空格

<= 64 字符

registration_region

enum<integer>

企业注册地址

可选

1：其他 2：中国大陆（默认） 3：中国香港 4：中国台湾

枚举值:

1234

registration_num

string

注册号

必需

企业社会信用代码或机构注册号，默认企业社会信用代码，长度不超过18位，由字母(区分大小写)或数字组成

>= 7 字符<= 20 字符

phone_num

string

联系人或授权人手机号

必需

7-12 位纯数字，不支持座机类型

>= 7 字符<= 12 字符

business_license

string

营业执照或认证授权人声明书

可选

可传入企业营业执照或授权人声明书的文件存储链接

<= 256 字符

email

string

企业邮箱

可选

长度限制为64位，需符合邮箱规范，如"xxx@xxx.xx"

示例

{
  "user_type": 0,
  "phone_num": "strings",
  "individual": {
    "name": "string",
    "region": 1,
    "certificate_type": 1,
    "certificate_num": "string",
    "phone_num": "strings"
  },
  "enterprise": {
    "name": "string",
    "registration_region": 1,
    "registration_num": "strings",
    "phone_num": "strings",
    "business_license": "string",
    "email": "string"
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://apis.avata.bianjie.ai/v3/users' \
--header 'X-Api-Key;' \
--header 'X-Api-Key;' \
--header 'X-Timestamp;' \
--header 'X-Timestamp;' \
--header 'X-Signature;' \
--header 'X-Signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_type": 0,
    "phone_num": "strings",
    "individual": {
        "name": "string",
        "region": 1,
        "certificate_type": 1,
        "certificate_num": "string",
        "phone_num": "strings"
    },
    "enterprise": {
        "name": "string",
        "registration_region": 1,
        "registration_num": "strings",
        "phone_num": "strings",
        "business_license": "string",
        "email": "string"
    }
}'

返回响应

🟢200successful operation

application/json

Body

data

object

返回值

可选

user_id

string

用户唯一标识

必需

did

string

用户身份标识(当前版本预留字段)

必需

示例

{
  "data": {
    "user_id": "string",
    "did": "string"
  }
}

🟠400failed operation