接口描述
为个人创建签署账号接口用于与开发者的自身业务系统的用户账号打通,调用此接口的唯一标识是
thirdPartyUserId,开发者需确保传入的 thirdPartyUserId 唯一,可以是用户的手机号、身份证号码等,
创建成功后接口将返回唯一的 accountId,与传入的thirdPartyUserId 一 一对应。
返回的 accountId 请注意妥善保存,以便用于后续签署业务。
【注意】
(1) 证件号 idNumber 规则说明:
1)接口不对传入的证件号进行真实性校验,需开发者确保证件号准确、真实。
2)签署账号创建成功后不允许再对证件号 idNumber 进行修改。
3)若证件号错误,可【注销个人签署账号】后使用正确号码重新创建账号。
4)同一个应用(AppID)下,同一证件号最多只允许绑定100个 thirdPartyUserId ,若超过限制数量时接口报错“该证件号创建用户数已达最大数量100个,不允许再继续创建”。此时,需要开发者调整账号创建逻辑。
5)建议开发者尽量确保一个证件号 idNumber 仅对应一个 thirdPartyUserId 。
(2) 关于报错“code=53000000,message=账号已存在”的说明:
此报错表示已使用 thirdPartyUserId 创建过账号,开发者可调用【查询个人签署账号】接口来获取 thirdPartyUserId 对应的accountId、姓名和证件号等信息,按实际情况做后续业务操作。
(3) 账号创建成功后e签宝会根据传入的姓名生成个人模板印章。
(4) 账号创建成功后e签宝会根据证件号及姓名申请数字证书,用于后续签署业务,以符合《电子签名法》要求。
API在线调试
可通过API在线调试工具使用接口功能,入口:创建个人签署账号
接口名称
/v1/accounts/createByThirdPartyUserId
请求方式
POST
请求头
提供两种安全接入方式,开发者可选择其中一种方式进行对接,对应参数如何获取,参考文档【请点击】。
方式一:请求签名鉴权(优先推荐)
请求头入参示例如下:
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 应用ID |
Content-Type | string | 是 | application/json;charset=UTF-8 |
X-Tsign-Open-Ca-Timestamp | string | 是 | API 调用者传递时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为15分钟,为了防重放攻击 |
Accept | string | 是 | 建议统一填写 */* |
X-Tsign-Open-Ca-Signature | string | 是 | 签名字符串 |
Content-MD5 | string | 否 | 当请求 Body 非 Form 表单时,可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时,加上此请求头。 |
X-Tsign-Open-Auth-Mode | string | 是 | 选择请求方式进行鉴权,固定值,Signature |
方式二:OAuth2.0鉴权(不推荐使用)
当安全接入选择OAuth2.0鉴权方式,请点击查阅详情,请求头入参示例如下:
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 应用ID |
X-Tsign-Open-Token | string | 是 | 通过获取鉴权Token接口返回 |
Content-Type | string | 是 | 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。 后续业务中e签宝会根据 idNumber 字段进行签署文件关联。 |
mobile | string | 否 | body | 手机号码,可空。 注:手机号为空时,无法通过短信接收签署相关通知, 且签署过程无法使用短信验证码做意愿认证 |
string | 否 | body | 邮箱地址,默认空 注:邮箱为空时,无法通过邮箱接收签署相关邮件通知 |
公共响应参数
参数名称 | 类型 | 必选 | 参数说明 |
code | int | 是 | 业务码,0表示成功 |
message | string | 是 | 信息 |
data | object | 是 | 业务信息 |
响应参数
参数名称 | 类型 | 必选 | 参数说明 | |
accountId | string | 否 | 个人账号id |
请求示例
{ "thirdPartyUserId":"2XXXX", "name":"**", "idType":"CRED_PSN_CH_IDCARD", "idNumber":"37XXXXXXXXXXXXXXXX", "mobile":"152XXXXXXXX", "email":"XX@XX.com" }
响应示例
{ "code":0, "message":"成功", "data":{ "accountId":"1eaf205d5d6d4e579a9d221dxxx" } }