创建邀请任务（无需账户）

更新时间：2022-02-18 18:22:24

接口描述

创建邀请任务，被邀请人收到通知后需要注册并完成实名认证方可开通电子签名服务。

注：自2022年1月12日起，邀请任务相关接口停止维护，e签宝不再允许再对接使用此接口。

接口

/v1/invitationWithData

请求方式

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

请求参数

参数名称	类型	必选	参数类型	参数说明
inviteType	String	是	body	邀请个人实名为PERSON，邀请企业为ORGAN
mobile	String	否	body	被邀请人手机号
email	String	否	body	被邀请人邮箱，若手机号和邮箱都传入，则仅手机号有效
name	String	否	body	被邀请人姓名
inviteeCertType	String	否	body	被邀请人证件类型，默认 CRED_PSN_CH_IDCARD CRED_PSN_CH_IDCARD 大陆身份证
idNumber	String	否	body	被邀请人证件号
organName	String	否	body	企业名称
organCertType	String	否	body	证件类型，默认CRED_ORG_USCC （1）CRED_ORG_USCC 统一社会信用代码（2）CRED_ORG_REGCOD E工商注册号
organCertNo	String	否	body	企业证件号
legalName	String	否	body	企业法定代表人姓名
legalCertType	String	否	body	企业法定代表人证件类型，默认 CRED_PSN_CH_IDCARD CRED_PSN_CH_IDCARD 大陆身份证，默认值
legalNo	String	否	body	企业法定代表人证件号
redirectURL	String	否	body	结束后重定向地址（需加前缀https:// 或 http:// ），默认停留在当前页面
callbackURL	String	否	body	回调接口地址，默认为空，不回调
bizId	String	否	body	业务方id，重定向和回调时都回传这个id
notifyType	String	否	body	默认为空，传入“sms”表示短信，“email”表示邮件，若两者都传入，则只发送短信

公共响应参数

参数名称	类型	必选	参数说明
code	int	是	业务码，0表示成功
message	string	否	信息
data	object	否	业务信息

响应参数

参数名称	类型	必选	参数说明
invitationId	string	否	邀请任务id
invitationURL	string	是	邀请链接，短链接
invitationOriginURL	string	是	邀请链接，长链接

请求示例

POST /v1/invitations

{
  "bizId": "123456",
  "callbackURL": "https://www.baidu.com",
  "inviteType": "PERSON",
  "notifyType": "sms",
  "redirectURL": "http://127.0.0.1"
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "invitationId": "de97a4904ea6****66afe799",
        "invitationURL": "https://smlt.tsign.cn/pMZnwZ7mKGhn",
        "invitationOriginURL": "http://smlh5.esign.cn/usercenterFront/middlepage****2071b"
    }
}

错误码

错误码	错误描述	解决方案