创建个人签署账号

更新时间:2023-09-27 15:49:33

接口描述

为个人创建签署账号接口用于与开发者的自身业务系统的用户账号打通

  • 调用此接口的唯一标识是thirdPartyUserId,开发者需确保传入的 thirdPartyUserId 唯一,可以是用户的手机号、身份证号码等,创建成功后接口将返回唯一的 accountId,与传入的thirdPartyUserId 对应。
  • 返回的 accountId 请注意妥善保存,以便用于后续签署业务。

【注意

(1) 证件号idNumber规则说明:

  • 接口不对传入的证件号进行真实性校验,需开发者确保证件号准确、真实。
  • 签署账号创建成功后不允许再对证件号 idNumber 进行修改。
  • 若证件号错误,可【注销个人签署账号】后使用正确号码重新创建账号。
  • 同一个应用(AppID)下,同一证件号最多只允许绑定100个 thirdPartyUserId ,若超过限制数量时接口报错“该证件号创建用户数已达最大数量100个,不允许再继续创建”。此时,需要开发者调整账号创建逻辑。
  • 建议开发者尽量确保一个证件号 idNumber 仅对应一个 thirdPartyUserId 。

(2) 关于报错“code=53000000,message=账号已存在”的说明:

此报错表示已使用 thirdPartyUserId 创建过账号,开发者可调用【查询个人签署账号】接口来获取 thirdPartyUserId 对应的accountId、姓名和证件号等信息,按实际情况做后续业务操作。

(3) 账号创建成功后e签宝会根据传入的姓名生成个人模板印章。

(4) 账号创建成功后e签宝会根据证件号及姓名申请数字证书,用于后续签署业务,以符合《电子签名法》要求。

接口Url

/v1/accounts/createByThirdPartyUserId

请求方式Method

POST

请求头Header

提供两种安全接入方式,开发者可选择其中一种方式进行对接,对应参数如何获取,参考文档【请点击】。

方式一:请求签名鉴权(优先推荐)

请求头入参示例如下:

参数名称

类型

必选

参数类型

参数说明

X-Tsign-Open-App-Id

string

Header

应用ID,通过开放平台创建获取

Content-Type

string

Header

application/json;charset=UTF-8

X-Tsign-Open-Ca-Timestamp

string

Header

API 调用者传递时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为15分钟,为了防重放攻击

Accept

string

Header

建议统一填写 */*

X-Tsign-Open-Ca-Signature

string

Header

签名字符串

Content-MD5

string

Header

当请求 Body 非 Form 表单时,可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时,加上此请求头。

X-Tsign-Open-Auth-Mode

string

Header

选择请求方式进行鉴权,固定值,Signature

方式二:OAuth2.0鉴权(不推荐使用)

当安全接入选择OAuth2.0鉴权方式请点击查阅详情,请求头入参示例如下:

参数名称

参数类型

必选

参数位置

参数说明

X-Tsign-Open-App-Id

string

Header参数

应用ID,通过开放平台创建获取

X-Tsign-Open-Token

string

Header参数

通过获取鉴权Token接口返回

Content-Type

string

Header参数

application/json; charset=UTF-8

请求参数

参数名称

类型

必选

参数类型

参数说明

thirdPartyUserId

string

Body

创建个人账号的唯一标识。可将个人证件号、手机号、邮箱地址等作为此账号的唯一标识。

注:

(1)创建个人账号和机构账号时,个人账号的唯一标识和机构账号的唯一标识不可重复;

(2)开发者需保证字段thirdPartyUserId平台方业务系统不可重复。

name

string

Body

姓名

idType

string

Body

证件类型,默认CRED_PSN_CH_IDCARD

(1)CRED_PSN_CH_IDCARD 大陆身份证,默认值

(2)CRED_PSN_CH_TWCARD 台湾来往大陆通行证(台胞证)

(3)CRED_PSN_CH_MACAO 澳门来往大陆通行证(回乡证)

(4)CRED_PSN_CH_HONGKONG 香港来往大陆通行证(回乡证)

(5)CRED_PSN_PASSPORT 护照

idNumber

string

Body

证件号,请传入真实的证件信息

注:身份证中有X字母的,需要传入大写的X

mobile

string

Body

手机号码,默认空。

注:手机号为空时无法接收签署短信通知并且无法使用短信验证方式进行意愿认证。

email

string

Body

邮箱地址,默认空。

注:邮箱地址为空时无法接收签署邮件通知并且无法使用邮箱验证方式进行意愿认证。

公共响应参数

参数名称

参数类型

必选

参数说明

code

int

业务码,0表示成功

message

string

业务描述信息  

data

object

业务数据

响应参数

参数名称

参数类型

必选

参数说明

accountId

string

个人账号id

注:用于实名认证、签署服务作为个人账号标识传入

请求示例  

POST https://openapi.esign.cn/v1/accounts/createByThirdPartyUserId
{
    "thirdPartyUserId":"211****1311",
    "name":"张**",
    "idType":"CRED_PSN_CH_IDCARD",
    "idNumber":"342*****94915",
    "mobile":"17****26",
    "email":"ki***6@qq.com"
}

Postman请求示例

响应示例

{
    "code":0,
    "message":"成功",
    "data":{
        "accountId":"1eaf205d5d6d4e579a9d221d7752xxx"
    }
}

错误码

错误码

错误描述

解决方案

401



1.token过期了

2.header请求头不正确

3.apiurl和应用ID环境不对应,例如apiurl是模拟环境,应用ID是正式环境的


我要纠错