开发者可通过更新日志查看API接口的发版更新内容,便于后续对接使用。
2023/04/13
[变更]更名:所有涉及e签宝刷脸的认证方式全部变更为快捷刷脸
2022/04/29
[新增]【一步发起签署】接口新增非必填参数sealBizTypes,支持指定签署时的印章业务类型,适用于发起某一类合同时仅允许盖合同专用章等场景(指定业务类型的印章需在发起签署前创建好)。
2022/04/15
[变更]签署完成、签署流程过期短信通知规则变更:4月15日恢复对抄送人的短信通知。
[新增功能] PC端打开签署链接时,增加转交经办人功能,【经办人转交签署任务回调通知】中回调新增参数
接收人账号ID : receiverAccountId 。
2022/04/01
[新增响应参数] 实名认证与授权API中【查询个人授权认证信息】接口新增响应参数psnSmFlowId(个人实名认证流程ID)、【查询组织机构授权认证信息】接口新增响应参数orgSmFlowId(企业实名认证流程ID),支持返回用户实名认证时具体的流程ID。
2022/03/24
[变更]签署完成、签署流程过期短信通知规则变更:
自3月24日起,签署完成、签署流程过期,默认仅向流程发起人发送短信通知,参与人不再会接收到短信通知。
(回调通知规则不变)
2022/03/04
[新增参数值]【一步发起签署】、【签署流程创建】、【添加签署方手动盖章签署区】签署相关接口中,意愿认证配置参数willTypes新增“微信智能视频认证”(VIDEO_WE_CHAT_VIDEO_DUAL)方式。
2022/03/01
[新增] 移动端SDK产品说明由组文件改为组内新建文件方式【移动端SDK】,【Android集成说明】新增功能方法说明模块(包含页面自定义颜色等功能),【iOS集成流程】新增e签宝刷脸页自定义颜色。
2022/02/23
[新增]【一步发起备注签署】接口新增备注签署区字体文字大小配置参数:remarkFontSize。
2022/01/25
[新增] 实名认证与授权认证服务中,【获取认证链接】接口,新增参数receiveUrlMobileNo与receiveUrlEmail,支持通过短信/邮件发送认证链接,完成认证
2022/01/13
[变更] 实名认证与授权认证服务中,【获取认证链接】接口,请求参数organizationType组织机构类型为“其他组织”时,入参值由 3 变更为 99。
2022/01/11
[变更] 签署流程归档变为签署流程结束,以便开发者更容易理解,仅中文名称变更,其功能保持不变,详见【签署流程结束】接口描述。如无特殊说明,文档其他地方以及报错信息中的【归档】等同于【结束】。
[变更] 自2022年1月12日起,邀请任务相关接口将停止维护,e签宝不再允许再对接使用此接口,涉及接口如下:
【创建邀请任务(需先创建账户)】【创建邀请任务(无需账户)】【查询邀请任务】
2022/01/06
[新增] 模板管理API中新增:【查询e签宝官网模板信息】接口。
2021/12/17
[新增] 签署流程中支持用户添加备注信息功能上线:新增【一步发起备注签署】接口。
2021/11/25
[新增] 【获取认证链接】接口新增字段:forceRealname,可允许设置用户重复认证。
2021/11/23
[变更]
模拟环境中自 2021年11月23日的14:20时起,正式环境中自 2021年11月25日的20:00时起
使用【创建个人签署账号】接口和【创建机构签署账号】接口创建账号时:
(1)同一个AppId下,同一个idNumber证件号最多只允许被创建100个账号accountId或orgId,即一个证件号只可以被100个thirdPartyUserId创建账号。
(2)如果超过100个,再调用【创建个人签署账号】或【创建机构签署账号】接口时将返回报错信息:“该证件号创建用户数已达最大数量100个,不允许再继续创建”。
如果遇到 “该证件号创建用户数已达最大数量100个,不允许再继续创建” 的报错时:
(1)请贵司研发人员查询贵司库中所保留的最新一个账号ID,如此账号ID正确无误,可直接用于发起签署使用。
(2)如果已存在账号ID信息不正确,可以通过【修改个人签署账号】或【修改机构签署账号】接口进行更新。
(3)如果还想再新创建账号,可以先通过【注销个人签章账号】或【注销机构签署账号】接口注销后再创建。
2021/11/23
[变更]
自2021年11月23日起,“邀请开通服务”相关接口将归档到“历史接口”下,已使用此接口的用户可继续使用。
2021/11/22
[新增]
文档新增“实名认证与授权认证”相关接口,用户在对接前请先咨询交付顾问。
2021/10/14
更新内容:
为了使签署过程实名意愿和签署意愿认证方式更加可控,API支持发起签署时指定不同签署人的意愿认证方式
[新增] 【一步发起签署】接口中在 signerAccount 下增加 willTypes 参数,开发者通过此参数可设置用户能够使用的意愿认证方式。signerAccount 下设置的 willTypes 优先级高于 flowConfigInfo 下设置的 willTypes。
[新增] 【添加签署方手动盖章签署区】接口中在 signfields 下增加 willTypes 参数,开发者通过此参数可设置用户能够使用的意愿认证方式。signfields 下设置的 willTypes 优先级高于【签署流程创建】中configInfo 下设置的 willTypes。
- 使用说明:
签署人实名认证使用了刷脸认证,若需在签署中意愿认证指定刷脸认证,则在一步发起签署时,willTypes传入参数FACE_ZHIMA_XY(支付宝刷脸),即可避免签署人意愿认证使用短信验证等方式签署。
2021/07/09
微信小程序对接说明文档迭代更新
2021/07/06
[停止] 自2021年7月6日起,【文件添加数字水印】接口不再允许新开发者集成调用。
此接口文档信息已移到文档中“历史接口”目录下。
2021/02/04
更新内容:
1、产品名称变更
e签宝将于2021年02月04日将产品名称由“电子签名服务SaaS API”变更为“电子签名 SaaS API 标准版”。本次仅涉及产品名称变更,其接口及参数保持原有不变。
2、异步回调规则优化说明
背景描述:
当同一个签署人给多个签署主体并在同一签署循序进行签署时,签署后,只会触发最后一个签署主体签署完成的异步回调通知。
优化说明:
异步回调通知将按照签署任务进行执行,即一个签署任务定义为同一个主体、同一个签署人和同一个顺序的签署区。签署完成后,一个签署任务即触发一次签署完成异步回调通知。
例如:
(1)如果一个人A有两个签署主体,是A个人和公司B,签署顺序均为1,那签署完成时,触发两次回调通知,分别为A个人签署完成的回调通知和公司B签署完成的回调通知;
(2)如果一个人A有一个签署主体,是公司B,但是签署区的类型包括了公司B的公章、法定代表人章,那签署完成时,只会触发一次回调通知,即公司B签署完成的回调通知。
3、新增 assignedPosbean 字段说明
一步发起签署接口/api/v2/signflows/createFlowOneStep
将新增 assignedPosbean
字段。
assignedPosbean:表示签署过程中,是否固定指定的签署区位置,true-固定签署区位置且无法移动,false-不固定签署区位置且签署时可自由移动,默认为true;其中,只有当signType为1或者2时,该字段才会生效。
入参格式如下:

字段组合规则如下:
signType | posBean | assignedPosbean | 处理逻辑 |
0 | 非必传 | 无效 | 正常发起,自由移动签章位置,骑缝/单页,可追加多个章 |
1 | 必传 | true | 正常发起,无法移动签章位置,单页签署,不可追加多个章 |
1 | 必传 | false | 正常发起,自由移动签章位置,单页签署,不可追加多个章 |
2 | 必传 | true | 正常发起,无法移动签章位置,骑缝签署,不可追加多个章 |
2 | 必传 | false | 正常发起,自由移动签章位置,骑缝签署,不可追加多个章 |
2021/01/08
更新内容:
开发者在对接过程中,需注意本次计划更新内容:
因Windows操作系统中文件名称不支持个别特殊字符,现调整所有涉及文件名称的接口字段不支持以下9个字符:/ \ : * " < > | ?
1、影响客户范围:对接e签宝电子签名 SaaS API 非标版和电子签名 SaaS API 标准版的客户
2、限制接口和参数范围如下:
①通过上传方式创建文件 /v1/files/getUploadUrl的入参fileName
②通过上传方式创建模板 /v1/docTemplates/createByUploadUrl的入参fileName
③通过模板创建文件 /v1/files/createByTemplate的入参name
④一步发起签署 /api/v2/signflows/createFlowOneStep的入参businessScene,attachmentName,fileName
⑤签署流程创建 /v1/signflows的入参businessScene
⑥流程文档添加 /v1/signflows/{flowId}/documents的入参fileName
⑦流程附件添加 /v1/signflows/{flowId}/attachments的入参attachmentName
3、其中①②③条限制规则计划上线时间:2021年1月14日;其中④⑤⑥⑦后续会增加限制,建议本次统一进行检查修正,后续上线不再另做通知
2020/12/30
更新范围:
12月30日,企业印章授权功能,正式环境全量发版上线。
本次新增的企业印章授权功能,预计会在2021年1月中旬,计划做授权管理限制,开发者需要注意下面几点:
预计2021年1月中旬,会对企业印章授权做以下限制:
1、一个企业主体最多只能创建5个企业印章(包括企业主体实名注册后生成的默认印章);
2、每个企业印章都可以用于授权,但是每个印章只能创建5个授权(其中可以授权给4家其他企业,另外一个是本企业内部员工授权);
更新内容:
1、e签宝官网-企业控制台-印章管理,新增【新增授权】功能,实现将企业印章授权给企业内部员工和其他企业,具体操作流程及先关注意事项参考《如何实现印章授权》。
2、API接口列表新增【印章服务API】板块,并新增接口【查询授权印章列表】。
3、【一步发起签署】接口,明细了sealIds和sealId两个字段的功能描述,并支持平台自身签署时,通过sealId指定企业授权印章编号。

4、【添加平台方自动盖章签署区】接口,支持通过sealId指定企业授权印章编号。
2020/12/11
更新范围:
12月11号,正式环境全量发版上线
更新内容:
1、电子签名 SaaS API 非标版支持在B2B签署场景下,使用e签盾方式进行签署,具体可参考《如何使用e签盾发起签署流程》;
2、一步发起签署接口和创建签署流程接口,新增“是否使用e签盾”字段,参数名称mobileShieldWay
。
其中1-不使用e签盾;2-使用e签盾
入参样例:
- 创建签署流程,入参格式:

- 一步发起签署,入参格式:
