e 签宝电子合同开放服务开放平台资料
e 签宝电子合同开放服务开放平台资料
杭州天谷信息科技有限公司 2018 年 5 月
保密声明 |
x文档包含杭州天谷信息科技有限公司的专用商业信息和保密信息。本文档保密时间为 20 年。 接受方同意维护本文档所提供信息的保密性，承诺不对其进行复制，或向其他公司或个人公开此信息。对于以下三种信息，接受方可不向天谷公司承担保密责任： ⚫ 可以通过其他渠道公开获得的信息； ⚫ 天谷科技承诺可公开的信息； ⚫ 已超过保密时间要求的信息。 |
文档修改记录 | |||
序号 | 修改人 | 修改时间 | 内容说明 |
1 | 小环 | 2018-05-11 | 创建 |
目录
1 产品简介
“e 签宝电子合同开放服务” 围绕电子合同全生命周期，提供了一套完整连贯的身份核验+合同签署 +数据存证服务（包括实名认证、证书申请、在线签署、印章管理、合同管理、合同签署流程管理、自动存证、在线出证、在线仲裁等服务）。由 e 签宝电子合同签约平台完成签署任务的送达、签署人的身份核验、合同展示、合同签署、签署人签约意愿核验、多人签署流程控制、全流程证据存证一站式服务，支持发起多人批量签署，同时基于支付宝、微信、手机/PC 浏览器各应用，为机构对个人签约（B2C）、机构对机构签约（B2B）、个人对个人签约（C2C）等应用场景提供多样签署方式。
以 API 的方式进行开放，在保持客户自有产品的整体性的同时，满足业务场景中的个性化需求，提供 99.99%的数据可靠性和 99.99%的服务可用性，帮助第三方合作伙伴创建更具竞争力的应用。
下图为电子合同开放服务生态体系，e 签宝与全国公民身份认证中心、银联等权威机构合作，打了精准可靠的用户身份认证体系；与工信部授权的电子认证中心机构（CA）提供数字证书发放服务、时间戳固化服务；同时，e 签宝与公证处、司法鉴定中心和仲裁委合作，增强电子合同证据的法律效力，为司法诉讼提供更有力的支撑。
1.2.1 远程签署
场景介绍
远程签署，指通过邮件、手机号、微信公众号等方式发送签署地址到签署人手中。通过点击签署地址进入 e 签宝应用中进行签署的模式。该模式适用于用户不在签署现场的场景。
支持用户使用 3 种方式完成签署：
第一种：使用支付宝 APP 查看签署的文件，并刷脸完成签署。第二种：使用微信 APP 查看签署的文件，并刷脸完成签署。
第三种：使用移动/PC 浏览器查看签署的文件，并通过刷脸证完成签署。
典型示例：法律文书在线送达，接收方在线签署回执单确认已接收
业务流程：
使用步骤
用户使用支付宝 APP 完成签署
1. 法院人员在法律文书送达系统操作生成法律文书、回执单，并发送签署地址到用户手机中，如图 1；
2. 用户点击短信中的签署地址跳转到 e 签宝签署方式选择页面，并选择使用支付宝签署，如图 2；
3. 系统自动唤起用户的支付宝 app，调起 e 签宝支付宝生活号预览合同，如图
3
4. 用户预览合同确认无误，点击“确定”唤起前置摄像头进行人脸识别，核实签署人身份，校验是否与平台指定的签署人身份一致，如图 4；
5. 刷脸认证通过，完成合同签署，并展示签署结果，如图 5；
用户使用微信 APP 完成签署
1. 法院人员在法律文书送达系统操作生成法律文书、回执单，并通过法院微信公众号发送签署地址到用户手中，如图 1；
2. 用户点击法院微信公众号中的签署地址跳转到 e 签宝签署方式选择页面，并选择使用微信签署，如图 2；
3. 系统自动唤起微信小程序预览合同，如图 3；
4. 用户预览合同确认无误，点击“确定”，用户完成唇语活体检测，如图 4；
5. 验证通过，完成合同签署，并展示签署结果，如图 5；
用户使用手机浏览器完成签署
1. 法院人员在法律文书送达系统操作生成法律文书、回执单，并发送签署地址到用户手机中，如图 1；
2. 用户点击短信中的签署地址跳转到 e 签宝签署方式选择页面，并选择使用浏览器（H5）签署，如图 2；
3. 系统自动唤起用户手机浏览器，预览合同，如图 3
4. 用户预览合同确认无误，点击“确定”，用户在手机端完成刷脸认证，如图
4；
5. 刷脸认证通过，完成合同签署，如图 5。
1.2.2 扫码签署
场景介绍
扫码签署，指用户使用 “扫一扫”功能，扫描平台展示在某签署场景下的二维码并进行签署的模式。该模式适用于线下实体店签署、面对面签署等场景。
典型示例：银行线下柜台办理开户业务
业务流程：
使用步骤
1. 银行柜台人员在银行业务系统操作生成开户申请协议，并生成二维码，如图
1；
2. 用户点击手机“扫一扫”功能，进入扫一扫界面，如图 2；
3. 用户扫描银行柜台人员提供的二维码，进入 e 签宝签署方式选择页面，并选择使用支付宝签署，如图 3；
4. 系统自动唤起用户的支付宝 app，调起 e 签宝支付宝生活号查看合同，如图
4；
5. 用户预览合同确认无误，点击“确定”唤起前置摄像头进行人脸识别，核实签署人身份，校验是否与平台指定的签署人身份一致，如图 5；
6. 刷脸认证通过，完成合同签署，支付宝端显示签署结果，如图 6；
7. 自动返回签署结果到对接平台系统中，对接平台根据签署结果进行个性化展示，如图 7。
1.2.3 跳转签署
场景介绍
跳转签署，指用户在平台某签署场景下，无需通过短信、邮件等方式通知签署，在平台业务流程中，直接从平台页面无缝跳转至 e 签宝页面进行签署，签署后跳回平台页面内，进行下一步业务流程。该模式适用于 PC 线上门户网站签署场景。
典型示例：供应链采购合同签署
业务流程：
使用步骤：
1. 采购人员在采购系统填写订单信息生成合同，并向企业盖章人员发起盖章申请，采购系统产生一条待签署任务，如图 1；
2. 企业盖章人员登录采购系统查看任务，点击“查看”，进入 e 签宝预览合同页面，如图 2；
3. 企业盖章人员查看合同内容，确认签署， e 签宝给企业盖章人员发送短信验证码确认签署意愿，如图 3；
4. 短信验证码认证通过，完成合同签署，并展示签署结果，如图 4；
1.2.4 自动签署
场景介绍
自动签署，指无需预览合同、无需签署意愿认证，系统接到盖章申请后，自动
使用自己拥有的数字证书快速无感的完成签署。该模式适用于企业、学校证明类文档签署场景。
典型示例：在校教育成绩单证明
业务流程：
使用步骤：
6. 学生在学生信息系统选择证明类型，并申请盖章，如图 1；
7. 系统自动完成盖章，并返回文件下载地址，如图 2；
个人签署流程、企业签署流程如下图所示，描述电子合同开放服务核心功能接口调用顺序，包括账号注册、创建合同、发起签署、下载合同核心功能。
企业签署流程如下图所示，由于企业是一个组织实体，在签署和管理操作时需
要由经办人执行，故在创建企业时需要先完成企业经办人创建，并将经办人的账号与企业账号绑定，进行企业盖章时，完成经办人的签署身份核实后，即可使用企业数字证书进行签署。
企业经办人如授权对接平台可使用企业印章代为签署，则无需企业进行签署意愿认证即可完成签署。如图所示。
已上线的功能，持续更新中……
功能模块 | 场景 | 描述 |
用户管理服务 | 支持个人/企业账号同步创建 | API 同步平台应用用户体系，确保用户一一对应，同时备份用户实名信息，确 认用户主体身份 |
身份认证服务 | 采用支付宝人脸识别方式进行个人身份核实 | 用户可在支付宝 APP 中，通过人脸识别、眼纹识别、姓名和身份证号验证相结合的多因子实名认证完成身份核实， 该认证方式已达金融级安全水平。 |
数字证书服务 | 多家 ca 通道切换 | 对接多家权威 CA 机构，采用分流机制， 保证电子签名服务的稳定性。 |
支持多样数字证书类型 | e 签宝支持的证书类型包含用户长效数字证证书、时间戳证书、事件型签名 证书和指纹隐私证书。 | |
电子签名服务 | 本地文件创建合同 | 支持本地文件上传至 e 签宝创建合同；目前仅支持上传 PDF 格式文档签署。 （后续扩充支持图片、word、html、xml 等。） |
合同模板创建合同 | 支持使用合同模板创建合同，当需要发 起签署时，只需要选择预先设置好的合 |
同模板，通过接口传入填入项，省去本 地上传的麻烦，性能更高效。 | ||
发起多方签署，文件自动流转 | 发起签署时，当同一份文档需要多方签署时，发起者可一次选择所有接收人并自定义签署人的签署顺序，文档按照该顺序依次流转给接收人，当前接收人签署完毕，自动发送至下一个接收人进行 签署。 | |
发起多文件签署 | 发起签署任务时，发起者可同时发送多份文档给接收人，并可预先指定每份文档盖章位置，接收方只需完成一次意愿 认证，即可批量签署所有文档。 | |
在支付宝生活号中签署 | 目前仅支持在支付宝生活号签署。 （后续扩充微信小程序、e 签宝 web、e签宝 H5、e 签宝 app 同步更新最新签署任务，可在任意应用随时查看、签署最 新的合同。） | |
采用刷脸核身完成批量签署 | 签署时，通过人脸识别确认签署主体身份，保证与发起方指定的签署人身份一 致。 |
支持对接平台自动盖章 | 签署时，对接平台可通过接口直接调动自己的数字证书完成签署，无需做意愿认证。 | |
支持对接平台的企业用户静默盖章 | 企业经办人授权对接平台可使用企业印章代为签署，无需企业进行签署意愿认证即可完成签署， | |
过程管控 | 用户可以通过支付宝生活号，随时查看所有文档签署情况和操作日志，重要节点和操作将通过短信、邮件等多种方式提醒。签约过程中，合同发起方与接收方可随时撤销、拒签合同。 后续扩充微信小程序、e 签宝 web、e 签宝 H5、e 签宝 app 同步更新最新签署日志，可任意端查看。 | |
查询合同签署详情 | 支持通过接口查询最新签署详情 |
下载签署完成的合同 | 支持通过接口下载签署完成的合同 | |
撤销签署任务 | 支持通过接口撤销签署中的任务，撤销 后，所有人不可继续签署，不扣费。 | |
指定自定义签署顺序 | 支持自定义签署顺序，e 签宝将按照该顺序依次进行文档流转。 支持无序签署，则发起方发起签署后，所有接受方同时收到签署通知，可同时 在线签署合同。省时高效 | |
指定签署截止时间 | 支持指定签署截止时间，签署截止时间前未完成签署，则自动结束签署任务， 此时不扣费。 | |
支持手绘印章签署 | 用户签署时，可在签名面板手绘签名， 增加签约仪式感。 | |
支持模板印章签署 | 用户签署时，可使用默认的模板印章进 行签署，方便快捷。 | |
指定盖章位置 | 支持通过关键字定位、坐标定位、骑缝 盖章三种方式定位盖章位置。 | |
用户自主选择签署位置 | 在不指定盖章位置时，用户可在页面通 过拖拽方式选择盖章位置。 | |
指定签署人签署完成跳转 地址 | 用户在 e 签宝完成签署后，通过指定的 跳转地址自动返回对接平台系统中。 |
指定 e 签宝通知方式 | 支持邮件、短信通知用户。 | |
拒签 | 接收方进行签署时，可拒签，拒签后，签署任务结束，其他人不可继续签署， 不扣费 | |
合同管理服务 | 查看合同 | 用户可随时到e 签宝电子合同签约平台 查看、下载、签署所有合同。 |
合同模板管理 服务 | 创建模板 | 支持通过接口将包含表单域的 PDF 文 件上传到 e 签宝创建模板。 |
文件加密服务 | 全程加密 | e 签宝具备领先的技术优势，采用 2048位公钥密码算法、128 位传输和存储加密、256 位摘要算法，让数据时刻处于加密状态，唯一支持国密 SM1、SM2、 SM3、SM4 算法的互联网签名平台， |
存证服务 | 全程存证 | 区别于传统的仅对单一合同的保全，e签宝独创的场景式存证对双方交易过程中的用户身份信息、合同/协议签署信息、合同原文等信息分别实时固化，同时将证据对应的原文件保全到 e 签宝、公证处、司法鉴定中心，通过 e 签宝可一站式展示电子签约全流程，完整 回溯事件过程。 |
法律服务 | 提供多种类型证据 | 在司法服务阶段，免费提供 e 签宝电子合同签约凭证，支持在线申请权威第三方机构的出具的公证书、司法鉴定意见书。并且打通中国互联网协会调解中心 与中国广州仲裁委，用户可足不出户， 在线一键调解、一键仲裁，快速维权。 |
计费 | 支持指定付费方 | 默认付费方是对接平台，也可指定对接 平台的用户付费。 |
1) 保证在线签约合规合法，满足监管要求
围绕《中华人民共和国电子签名法》中可靠电子签名的“真实身份，真实意愿，签名未改，原文未改”四大核心要求，根据相关行业规范，提供一套完成连贯的电子合同签署+电子数据存证服务。
2) 多样的签署方式，满足对接方不同业务场景的签署需求
支持对接方发起多人顺序签、多人无序签、多份文件批量签署、单个文件多个盖章位置的批量签署，多人签署时，e 签宝控制签约人之间的合同流转，所有人签署完毕，自动返回最终电子合同至对接方。
同时为了给客户更高的用户体验，e 签宝打通支付宝、微信、H5 各端，签约人可自由选择一种签署端进行签署，其中签约人在支付宝端进行签署时，支付宝采用刷脸方式对签约人身份进行核实，强证明签约人的签署真实意愿，提高合同签署法
律效力。
3) 电子合同签约全流程在 e 签宝平台完成，让平台更中立
对接方发起签署后，e 签宝发送签署链接至签约人手机/邮箱中，当签约人打开链接在 e 签宝平台提供的签署页面上预览合同并进行签署时，e 签宝会根据对接平台的要求对签约人的身份信息进行校验，校验成功后，签约人方可进行合同的签署。整个签约过程无缝连接，全部由 e 签宝完成，平台无法变更签署流程。
4) 签约全程自动存证，免费提供存证凭证给签约人，降低违约风险
签约全程实时第三方备案，事中取证，事中固化，构建完整证据链，还原事实真相。
电子合同开发服务与快捷签之间服务对比。
产品名称 | 电子合同开放服务 | 快捷签 |
概述 | 第三方平台发起签署后，用户在 e 签宝平台完身份核实，在 e 签宝签署页面进行合同预览、签署意愿核实、合同签署；签署完毕后的合同保存在 e 签宝平台。 | 第三方平台发起签署后，即默认同意签署；签署完成后的文件将以 PDF 文件格式保存在第三方平 台。 |
对接平台是 e 签宝的真 实用户 | 是 | 是 |
合同接收人是 e 签宝的 | 是 | 否 |
真实用户 | |||
合同接收人身份核实由 e 签宝完成 | 是 | 否 | |
合同保存位置 | e 签宝平台 | 第三方平台 | |
文件摘要保存位置 | e 签宝平台 | e 签宝平台 | |
操作留痕 | 全程留痕 | 全程留痕 | |
签署交互 （即合同签署页） | 在 e 签宝默认的签署页， 签署页可嵌入第三方平台业务流程中。 | 在第三方平台中 | |
发起方签署平台 | 平台方：第三方平台； 平台方用户：e 签宝 | 第三方平台 | |
接收方签署平台 | e 签宝 | 第三方平台 | |
证据链完整性 | 整个签署流程在 e 签宝平台完成，由 e 签宝完成多人之间文件流程、文件预览、身份核实、签署意愿核实、文件签署，证据 更连贯完整 | 多人之间的文件流传由第三方平台完成，存在缺失签署人身份核实、签署意愿核实、 签署合同原文的环节数据，证据链不 够连贯完整。 |
2 产品定价
序号 | 报价 | 最大签名份数 | 集成实施 |
1 | 10000 元包年 | 封顶 2000 份 | 9800 元/每系统 |
2 | 22500 元包年 | 封顶 5000 份 | |
3 | 60000 元包年 | 封顶 15000 份 | |
4 | 175000 元包年 | 封顶 50000 份 | |
5 | 300000 元包年 | 封顶 100000 份 | |
6 | 面议 | 高于 200000 份 |
电子合同开放服务按照合同份数计费，使用前需要预先购买电子合同套餐，规格如下：
服务说明：
1) 多通道：WEB&支付宝&钉钉&APP
2) 实名认证：超过 10 种法人&个人实名认证服务
3) CA 通道：超过 10 家 CA 通道
4) 文件服务：文档转换、文档模板
5) 工作流程：支持自定义合同流程
6) 存证保全：合同自动存证司法鉴定和公证处
7) 开放服务：丰富接口适应不同的应用场景需求
8) 法律服务：e 签宝证据报告、司法鉴定报告、公证书
1) 按合同份数计费。
2) 采用先冻结后扣费的方式。
3) 当付费方是发起方时，则在签署任务发起时，根据需签署的合同份数冻结发起方的套餐，冻结成功，发起签署成功；当所有人签署完成，再实扣发起方的套餐。签署任务撤销、拒签、超过签署截止时间未完成的，均不扣费。
4) 当付费方是某一接收方时，则在接收方要签署时，进行套餐冻结，冻结成功，开始签署；当所有人签署完成，再实扣接收方的套餐。签署任务撤销、拒签、超过签署截止时间未完成的，均不扣费。
5) 免费提供合同存证。举例 1
xx入职杭州天谷信息科技有限公司，需要签署 2 份文件，一份是劳动合同，一份是保密协议。其中劳动合同需要xx与公司都盖章，保密协议只需要xx自己盖章，本次付费方为杭州天谷信息有限公司，因此本次费用需要扣掉杭州天谷信息有限公司 2 份合同套餐。
1) 套餐超限前会有告警(剩余 25%、10%时都会告警)。
2) 套餐到期前会有告警(到期前 30、15 天时都会告警)。
3) 当对接平台套餐余额不足或套餐到期，将无法发起需要对接平台付费的签署任务。
如果因业务需求，不再续费，对于已经保存在 e 签宝平台的合同，e 签宝将继续保存，用户可随时到 e 签宝平台查看、下载合同、以及申请出证。
3 快速入门
⚫ 第一步：创建应用
使用注册的 e 签宝实名企业账号登录开放平台：
xxxx://xxxx.xxxxx.xx/xxxxx/xxx-xxxxx-xxxx.xxxxx
进入“管理中心”→“创建应用”，填写应用的名称、英文名称、应用简介等必填项内容，完成应用的创建
注：应用名称请准确填写上线平台的名称。
进入“查看”，获取应用 ID（ProjectID） 和应用 Secret（ProjectSecret）
应用 ID（ProjectID）：应用身份标识，接口调用过程中代表调用者的身份。应用 Secret（ProjectSecret）：应用默认密钥，默认采用 HMAC-SHA256 算法签
名，ProjectSecret 即对应的密钥
⚫ 第二步：查看 HMAC-SHA256 密钥
应用默认采用 HMAC-SHA256 算法签名，在创建应用过程中生成的应用 Secret
即 HMAC-SHA256 密钥。
(一) 使用注册的 e 签宝实名企业账号登录开放平台：xxxx://xxxx.xxxxx.xx (二) 进入“管理中心”，找到需要查看的应用，点击“配置”按钮
(三) 进入密钥管理
(四) 选择 HMAC-SHA256 密钥，点击查看
⚫ 第三步：创建账号
调用接口在 e 签宝平台中创建个人账号，企业账号，作为后续合同签署主体完成签署。
⚫ 第四步：创建合同
发起签署前，需要将待签署的文件上传至 e 签宝。
支持 2 中方式创建合同，方式 1：上传本地文件创建合同，支持本地文件上传至 e 签宝创建合同；目前仅支持上传 PDF 格式文档签署。后续扩充支持图片、word、 html、xml 等；方式二：使用合同模板创建合同，当需要发起签署时，只需要选择预先设置好的合同模板，通过接口传入填入项，省去本地上传的麻烦，性能更高效。
⚫ 第五步：发起签署
通过接口指定待签署合同、签署人、签署顺序、签署人的签署位置等信息，快速发起多人签署，e 签宝根据接口传入的信息，自动完成文件流转，采用短信/邮件等通知方式通知签署人通过指定的签署方式完成签署通知所有签署人进行签署。
/sign/start
⚫ 第六步：查看签署详情
对接平台可通过接口实时查看所有人的签署进度。/sign/docdetail
⚫ 第七步：下载签署后合同。
当所有人签署完毕后，可通过接口下载签署后的合同。/sign/download
4 API 列表总览
1) thirdId
个人/企业在对接平台中的账户唯一标识，与 e 签宝账户存在唯一对应关系。
2) accountId
accountId 是个人/企业在 e 签宝中的标识，每个个人/企业拥有一个唯一的
accountId。
3) docId
文件上传 e 签宝后获取的唯一标识。为了保护平台文件的隐私性，可通过 docId删除留存在 e 签宝的原始文件及签署后的文件。一经删除，e 签宝不再留存此文件，用户也不能在 e 签宝平台查询到此文件。
4) templateId
合同模板上传 e 签宝后获取的唯一标识。创建合同时，可通过接口传入合同模板 templateId 及填入项，在 e 签宝服务端生成待签署文件，并返回模板填充后生成的文件 Id。
5) flowId
发起签署任务后，本次任务在 e 签宝的唯一标识。通过 flowId 可查询签署进度详情、下载签署后的合同、查询存证记录。
6) signUrl
发起签署后，signUrl 是每个签约人的签署地址，通过本地址，签约人可进入 e
签宝各个端（支付宝生活号、微信小程序、H5 等）预览合同、完成签署。
7) 企业经办人
创建企业帐号时，需要预先为企业经办人创建 e 签宝个人帐号，并进行关联，企业经办人拥有企业印章使用权限、企业合同管理权限，当需要企业盖章时，将签署链接发送至企业经办人，由企业经办人代企业进行盖章。企业经办人唯一。
8) 顺序签
顺序签署时签署方按照指定的签署顺序接收、签署合同。
9) 无序签
无序签署时签署方同时接收到合同，不限制签署顺序。
10) 关键字定位
发起签署时，可以通过输入关键字进行盖章位置定位，e 签宝根据关键字在文件中的查找所有符合的字段，并在该位置落章。
11) 坐标定位
发起签署时，通过输入文件页码与坐标位置进行盖章位置定位，e 签宝根据页码与坐标落章。
12) 骑缝盖章
发起签署时，可指定盖骑缝章，在文件交接处所加盖的印章。
x章节描述了第三方平台对接 e 签宝电子合同开放服务时可使用的接口定义，通过对接口的调用实现对账号、合同、签署任务等环节的操作。本章节中所有接口如无特殊说明约束，均满足以下调用规范：
⚫ 所有接口均采用 HTTP POST 方式调用
⚫ 所有接口请求入参采用 JSON 格式，Content-Type 类型仅支持 application/json
⚫ 所有接口返回响应数据采用 JSON 格式
⚫ 所有接口响应符合以下格式规范:
参数名 | 类型 | 必 填 | 说明 |
errCode | int | 是 | 接口调用状态码，0 – 表示成功，其他表示失败 |
msg | string | 否 | 接口调用结果描述，用于对 errCode != 0 时描述失败原因 |
data | JsonObject/JsonArray | 否 | 接口调用业务相关数据 |
注：后续接口文档中非无业务数据返回，则描述的数据结构为 data 节点的内容
⚫ 接入环境
测试环境接入地址：xxxxx://xxxxxxxxxx.xxxxx.xx/xxxxxxxxxx/xxxx/x0.0生产环境接入地址：xxxxx://xxxxxxx.xxxxx.xx/xxxxxxxxxx/xxxx/x0.0
4.3.1 请求签名方式
4.3.1.1 流程
1) 请求方确定当前签名方式
2) 请求方对请求进行签名运算
3) 将项目 ID、签名值、签名算法填入 HTTP-HEADER
4) 发送请求
4.3.1.2 签名算法
⮚ 目前平台支持基于 HMAC-SHA256 的普通密钥的哈希散列算法（摘要）。密钥：见快速入门第二步。
4.3.1.3 签名方式
整体签名方式
对请求的 HTTP-BODY 进行整体签名
4.3.1.4 编码方式
使用整体签名方式时，需要注意是对请求的 byte 流进行签名，同时将该 byte
流设置到 HTTP 请求体中，此时不需要关注具体的编码方式。
4.3.1.5 设置请求头
请求方需要在 HTTP-HEADER 中设置相关信息，以指示服务端以何种方式验证签名。
属性名(HEADER) | 属性名(URL) | 属性描述 | 属性值 | 默认值 |
X-timevale-mode | mode | 签名模式 | package: 整体签名 方式 | package |
X-timevale-project-id | projectId | 项目标识 | N/A | 无 |
X-timevale-signature | signature | 参数签名 | N/A | 无 |
X-timevale-signature- algorithm | signatureAlgorithm | 签名算法 | hmac-sha256:sha25 6 摘要算法; | hmac-sha256 |
4.3.2 响应验证方式
4.3.2.1 流程
1) 服务端业务处理
2) 服务端以客户端请求的签名方式，对响应数据进行签名，并设置响应头
3) 客户端接收响应，解析 HTTP-HEADER 中的系统参数（或者不解析，服务端的签名方式与请求时的相同）
4) 客户端得到签名，对服务端响应进行数据验证
4.3.2.2 验证算法
⮚ HMAC-SHA256
密钥：见快速入门第二步。验证时，使用的密钥与用户所持有的密钥相同，用户只需使用与请求相同的密钥，对响应数据进行摘要运算后进行对比，完成响应的验证工作。
4.3.2.3 验证方式
与 4.3.1.3 相同
4.3.2.4 编码方式
与 4.3.1.4 相同
4.3.2.5 获取响应头
参见 4.3.1.5 相同，响应的所有系统参数均只在响应头中出现
接口名称 | API 接口 | 接口描述 |
获取文件上传地址 | /file/uploadurl | 为隔离业务数据流和文件流，e 签宝采用文件直传的方式完成用户文件的上传。 对接方通过该接口获取文件上传的授权地址 由对接方直接使用本地合同原文进行签署时，需先调用该接口完成本地文件上传 e签宝 由对接方通过 API 接口创建合同模板时，需要先调用该接口完成模板文件上传 e 签 宝 |
创建个人账号 | /account/create/person/private | 对接方调用本接口在e 签宝平台中创建个人账号，作为后续合同 签署主体完成签署 |
创建企业账号 | /account/create/organize/private | 对接方调用本接口在 e 签宝 |
平台中创建企业账号，后续以企业的维度进行签署和管理 由于企业是一个组织实体，在签署和管理操作时需要由经办人执行，故在创建企业 时需要先调用 4.6.1 接口完成企业经办人创建，并将经办人的账号 Id 传入接口 | ||
创建模板 | /template/createbyfilekey | 在调用4.5 章节中的两个接口完成模板文件上传后，使用模板文 件 fileKey 创建模板 如果用户未完成模板文件流的上传，该接口调用会返回文件尚未上传成功的错误 如果在 4.5 章节指定文件的 contentType 类型不支持作为模板，则会返回类型不支持的错 误。目前仅支持 application/pdf 类型的模板 |
本地文件创建合 同 | /doc/createbyfilekey | 在调用 4.5 接口完成合同原 文上传后， 使用合同原文 |
fileKey 创建待签署合同 如果用户未完成合同文件流的上传，该接口调用会返回文件尚未上传成功的错误 | ||
合同模板创建合同 | /doc/createbytemplate | 支持对接方在定义合同模板后，基于合同模板生成合同 用于后续合同签署 |
获取合同下载地址 | /doc/downloadurl | 支持对接方根据合同 docId 获取合同下载地址，用于获取合同原文 |
发起合同签署 | /sign/start | 平台对接方通过指定签署合同 Id、签署人、签署方式、签署印章等参数，创建合同签署任务 如果接口中未配置静默签署参数，e 签宝将采用短信/邮件等通知方式通知签署人通 过指定的签署方式完成签署；平台对接方也可以展现 签署二维码指引签署人完成 |
签署 | ||
撤销签署 | /sign/revoke | 支持对接方通过签署任务 id 终止正在进行中的签署流程，撤销 后，所有人不可签署，不扣费。 |
签署文件下载 | /sign/download | 持对接方通过签署任务 id 获取 流程中已经完成签章的文件 |
查看合同签署详 情 | /sign/docdetail | 支持对接方通过签署任务 id 查询签署进度 |
4.5.1 获取文件直传地址
接口描述：
⚫ 为隔离业务数据流和文件流，e 签宝采用文件直传的方式完成用户文件的上传。对接方通过该接口获取文件上传的授权地址
⚫ 由对接方直接使用本地合同原文进行签署时，需先调用该接口完成本地文件上传 e
签宝
⚫ 由对接方通过 API 接口创建合同模板时，需要先调用该接口完成模板文件上传 e
签宝
接口地址：
/file/uploadurl
请求参数：
参数名称 | 类型 | 必选 | 参数说明 |
fileName | String | 是 | 文件名称 | |
fileSize | long | 是 | 文件大小，单位字节 | |
contentType | String | 是 | 文件内容的 MIME 类型描述字符串 | |
contentMd5 | String | 是 | 采用 BASE64 编码的文件 MD5 摘要值 |
响应参数：
参数名称 | 类型 | 必选 | 参数说明 |
fileKey | String | 是 | 文件标识，用于后续创建合同 |
uploadUrl | String | 是 | 文件上传授权链接，1 小时内有效 |
请求示例：
{
"contentMd5":"eB5eJF1ptWaXm4bijSPyxw==", "fileName":"xx的借款合同.pdf", "fileSize":151660， "contentType":"application/pdf"
}
返回示例：
{
"fileKey":"$333e7706-3277-4e67-88d4-7f9183a7cde9$386813809
2",
"uploadUrl":"xxxxx://xxxxxxxx.xxx-xx-xxxxxxxx.xxxxxxxx.xxx
/open/1111563795_1087b033-2a4e-4176-a192-8486c4bf7d80.pdf?Exp ires=1524013961&OSSAccessKeyId=FBzUaPMorqiiUAfb&Signature=bP6 kcOo%2BiZriqtlZqO11/EOZ3vs%3D"
}
4.5.2 上传文件
接口描述：
⚫ 使用 5.1.1 接口获取到的uploadUrl 进行文件流上传
⚫ 上传使用 HTTP PUT 方式上传
⚫ 上传时需要在 HTTP Header 中增加字段 Content-MD5 和 Content-Type，字段值与 5.1.1 接口中 contentMd5 和 contentType 值保持一致，否则会出现错误码为 403的错误。
接口地址：
5.1.1 接口获取到的 uploadUrl
请求参数：
待上传文件的二进制字节流
4.6.1 创建个人账号
接口描述：
对接方调用本接口在 e 签宝平台中创建个人账号，作为后续合同签署主体完成签署
接口地址：
/account/create/person/private
请求参数：
参数名称 | 类型 | 必选 | 参数说明 |
thirdId | String | 否 | 对接方用户唯一标识 最大支持 50 个字节 |
name | String | 是 | 姓名 |
idNo | String | 是 | 证件号 |
idType | int | 是 | 详见个人账号证件类型 |
mobile | String | 否 | 手机号 |
String | 否 | 邮箱 |
响应参数：
参数名称 | 类型 | 必选 | 参数说明 |
accountId | String | 是 | e 签宝账户唯一标识 |
请求示例：
{
"thirdId":"097a56e26a93c874140bbcdf403f3f60", "name":"xx",
"idNo":"371500198101175693",
"idType":19, "mobile":"00000000000",
"email":"xxxx00@xxxxx.xx"
}
返回示例：
{
"accountId":"fa71cad7423411e8b00f00163e107e9c"
}
4.6.2 创建企业账号
接口描述：
⚫ 对接方调用本接口在 e 签宝平台中创建企业账号，后续以企业的维度进行签署和管理
⚫ 由于企业是一个组织实体，在签署和管理操作时需要由经办人执行，故在创建企业时需要先调用 5.2.1 接口完成企业经办人创建，并将经办人的账号 Id 传入接口
接口地址：
/account/create/organize/private
请求参数：
参数名称 | 类型 | 必选 | 参数说明 | |
thirdId | String | 否 | 对接方用户唯一标识 最大支持 50 个字节 | |
agentAccountId | String | 是 | 企业经办人的 e 签宝账户 Id，由接口 5.2.1 的调 用返回的 accountId | |
name | String | 是 | 企业名称 | |
organCode | String | 是 | 企业证照号 | |
organType | int | 是 | 详见企业账号证照类型 | |
legalName | String | 否 | 企业法人姓名 | |
legalIdNo | String | 否 | 企业法人证件号 | |
legalIdType | int | 否 | 详见个人账号证件类型 当证件号字段 legalIdNo 填写时，该字段必填 | |
String | 否 | 企业邮箱 |
响应参数：
参数名称 | 类型 | 必选 | 参数说明 |
accountId | String | 是 | e 签宝账户唯一标识 |
请求示例：
{
"thirdId":" 02080617B436452B8ABDCB85350CE4FA", "agentAccountId":"819795A5042948889360AB2622308C69",
"name":"天谷科技信息有限公司", "organCode":"745830607", "organType":12,
"legalName":"xx"， "legalIdNo":"33012219921122281X",
"legalIdType":19, "email":"xx@xxxxx.xx"
}
返回示例：
{
"accountId":"B8C8D979449E4753B4B4B67A9CD923DA"
}
4.6.3 查询 e 签宝账户 Id
接口描述：
⚫ 当对接方创建账户时传入 thirdId 时，支持使用 thirdId 查询 accountId
接口地址：
/account/idexchange
请求参数：
参数名称 | 类型 | 必选 | 参数说明 |
thirdId | String | 是 | 创建账户接口传入的接入方 thirdId |
响应参数：
参数名称 | 类型 | 必选 | 参数说明 |
accountId | String | 是 | 与 thirdId 对应的 e 签宝账号 id |
请求示例：
{
"thirdId":"2345678903456"
}
返回示例：
{
"accountId":"fdgf4h6f4h6"
}
4.7.1 创建模板
接口描述：
⚫ 在调用 5.1 章节中的两个接口完成模板文件上传后，使用模板文件 fileKey 创建模板
⚫ 如果用户未完成模板文件流的上传，该接口调用会返回文件尚未上传成功的错误
⚫ 如果在 5.1 章节指定文件的 contentType 类型不支持作为模板，则会返回类型不支持的错误。目前仅支持 application/pdf 类型的模板
接口地址：
/template/createbyfilekey
请求参数：
参数名称 | 类型 | 必选 | 参数说明 |
fileKey | String | 是 | 文件标识 |
templateName | String | 是 | 模板名称 |
templateTypeId | String | 否 | 模板创建后所属类别的 Id 预留字段，用于后续扩展支持模板管理功能 当前默认为“0”- 默认类别 |
templateFormKeys | List<String> | 否 | 扩展字段，预留 模板文件中待填充表单域的 Key 集合 如模板为 PDF 文档，由于文本表单域可直接在 PDF 文档中解析，故不需要填写； 如模板为非 PDF 文档，则需要指定 |
响应参数：
参数名称 | 类型 | 必选 | 参数说明 |
templateId | String | 是 | 模板 Id，用于 4.4.2 章节通过模板创建合同 |
请求示例：
{
"fileKey":"$e21b7762-fbfc-4a72-baa7-85ebc6a5a191$651935810"
}
返回示例：
{
"templateId":" 00099376d6fb47e3ba4e18587a95176d "
}
4.8.1 本地文件创建合同
接口描述：
⚫ 在调用 5.1 接口完成合同原文上传后，使用合同原文 fileKey 创建待签署合同
⚫ 如果用户未完成合同文件流的上传，该接口调用会返回文件尚未上传成功的错误
接口地址：
/doc/createbyfilekey
请求参数：
参数名称 | 类型 | 必选 | 参数说明 |
fileKey | String | 是 | 文件标识 |
响应参数：
参数名称 | 类型 | 必选 | 参数说明 |
docId | String | 是 | 合同 id |
请求示例：
{
"fileKey":"$333e7706-3277-4e67-88d4-7f9183a7cde9$386813809
2"
}
返回示例：
{
"docId":"2018041823454409001"
}
4.8.2 合同模板创建合同
接口描述：
⚫ 支持对接方在定义合同模板后，基于合同模板生成合同用于后续合同签署
接口地址：
/doc/createbytemplate
请求参数：
参数名称 | 类型 | 必选 | 参数说明 | |
templateId | String | 是 | 模板 id | |
name | String | 是 | 合同名称 | |
simpleFormFields | Map | 否 | 模板中预置简单文本域的 key-value 对。在模板填充过程中直接使用指定 value 进行 key 对应的文本域填充 | |
chunkedFields | Array | 否 | 指定数据块以新增页方式插入/追加到 合同中，最多支持增加 10 页 | |
mimeType | String | 是 | 待追加数据的 MIME 类型，目前支持： text/html， application/pdf 传参不区分大小写 | |
chunkedData | String | 是 | 以 Base64 格式编码的数据字节流 | |
sequence | int | 是 | 当多个数据块需要插入时，用于标记各 数据块形成合同页的次序 | ||
pagePos | int | 否 | 扩展字段，用于后续扩展在指定页后插入新的页。 目前仅支持在文档最后追加新页 |
响应参数：
参数名称 | 类型 | 必选 | 参数说明 |
docId | String | 是 | 合同 id |
docUrl | String | 是 | 由模板生成的合同下载地址，用于文档下载、 预览等场景，有效时长 1 小时。 |
请求示例：
{
"name":"借款合同", "templateId":"20180403120233", "simpleFormFields":{
"contractNo":"123456789", "borrower":"xx",
"idCardNo":" 110108196710262291"
},
"chunkedFields":[{ "mimeType":" text/html", "chunkedData":"
PCFET0NUWVBFIGh0bWw+CjxodG1sIGxhbmc9ImVuIj4KPGhlYWQ+Cjx0aXRsZ T5TdG9yeTwvdGl0bGU+CjwvaGVhZD4KPGJvZHk+CjxoMT5NeSBTdG9yeTwvaD E+CjxwPk9uY2UgdXBvbiBhIHRpbWUsaSBtZXQgYSBwcmV0dHkgZ2lybC4gQnV 0IC4uLjwvcD4KPC9ib2R5Pgo8L2h0bWw+",
"sequence":0
}]
}
返回示例：
{
"docId":"2018041823454409002",
"docUrl":"xxxxx://xxxxx-xxx-xxxxxxx.xxx-xx-xxxxxxxx.xxxxx xxx.xxx/xxxxxxxx/000000000000000000?Xxxxxxxx0000000000&XXXXxx essKeyId=LTAI5cUiq89a7YXT&Signature=CW/OJmythjqSxQReFbmPGRqkf aA%3"
}
4.8.3 获取合同下载地址
接口描述：
⚫ 支持对接方根据合同 docId 获取合同下载地址，用于获取合同原文
接口地址：
/doc/downloadurl
请求参数：
参数名称 | 类型 | 必选 | 参数说明 |
docId | String | 是 | 合同 id |
响应参数：
参数名称 | 类型 | 必选 | 参数说明 |
docUrl | String | 是 | 合同下载地址，有效时长 30 分钟 |
请求示例：
{
"docId":"2018041823454409003"
}
返回示例：
{
"docUrl":"xxxxx://xxxxxxxx.xxx-xx-xxxxxxxx.xxxxxxxx.xxx/00 11563621/6aaea72c-9036-44b7-96ef-9a7470a0333c/f8fe7180e9de406 18bcc57fec1f4c0d0.pdf?Expires=1525846738&OSSAccessKeyId=LTAId vHfiVrzDKbE&Signature=J4s7nt389pisoTnNioVhzctcIeI%3D"
}
4.9.1 发起合同签署
接口描述：
⚫ 平台对接方通过指定签署合同 Id、签署人、签署方式、签署印章等参数，创建合同签署任务
⚫ 如果接口中未配置静默签署参数，e 签宝将采用短信/邮件等通知方式通知签署人通过指定的签署方式完成签署；平台对接方也可以展现签署二维码指引签署人完成签署
接口地址：
/sign/start
请求参数：
参数名称 | 类型 | 必选 | 参数说明 |
businessScene | String | 是 | 业务场景名称 |
initiatorAccountId | String | 否 | 发起方账户 id，默认对接方 |
signValidity | long | 否 | 签署有效期时间戳毫秒值 |
contractValidity | long | 否 | 合同存档有效期时间戳毫秒值 |
payer | String | 否 | 付费方，默认对接方 |
autoInitiate | Xxxxxxx | 否 | 是否自动开始签署。 如果为 1，则表示接口返回成功后，签署任务立即进入签署中的状态，e 签宝 后台自动向参与人发出签署通知或自 |
动静默签署，无需调用接口 5.5.2； 如果为 0，则表示接口返回成功后，签署任务进入准备状态，待调用接口 | ||||||
5.5.2 后再进入签署中状态； 默认为 1. | ||||||
指定用户签署的平台 | ||||||
空值不限平台 | ||||||
signPlatform | String | 否 | 1:H5 签 2:支付宝生活号签 3:微信小程序签 多种签署平台以英文逗号分隔 | |||
用户接收签署任务通知的方式 | ||||||
空值不通知 | ||||||
noticeType | String | 否 | 1:e 签宝短信 2:邮箱通知 3:支付宝生活号 多种通知方式以英文逗号分隔 | |||
redirectUrl | String | 否 | 扫码签署完成后跳转地址 | |||
docList | Array | 是 | 合同信息 | |||
docId | String | 是 | 合同 id | |||
name | String | 否 | 合同名称，默认使用创建合同时的名称 | |||
recipientList | JSON | 是 | 接收人信息，至少有一个角色不为空 | |||
signerList | Xxxxx | 否 | 签署人信息 | |||
accountId | String | 是 | 签署人的 accountId | |||
authorizationOrgId | String | 否 | 授权签署人进行代理签署的企业 id 当个人以企业角色进行签署时包含该 | |||
参数 | ||||||
signOrder | int | 否 | 当前用户在整个签署流程中的签署顺 序，在需要进行有序签时指定 | |||
autoSign | int | 否 | 是否静默签署，0 否，1 是，默认 0 | |||
指定签署印章类型 | ||||||
空置不限类型 | ||||||
sealType | String | 否 | 0：手绘印章 1：模板印章 多种印章类型以英文逗号分隔 | |||
certType | int | 否 | 指定签署证书类型 1 长效云证书 | |||
2 事件证书 3 指纹证书 4 手机盾证书 5 ukey 证书 默认使用账户长效云证书签署 | ||||||||
docPosList | Array | 否 | 签署人对应文档的签署位置 当需要指定签署位置或者签署人无需参与所有文档签署时包含该参数 默认所有签署者必须签署所有合同，位 置由签署人通过印章拖拽指定 | |||||
docId | String | 是 | 合同 id | |||||
signType | int | 否 | x章位置定位方式 1 关键字定位 2 坐标定位 3 骑缝盖章 | |||||
qrcodeSign | int | 否 | 签署印章是否包含签署任务查看二维码标识 0 否，1 是，默认为 0 另当签署类型为骑缝签和多页签时，该标识无效 | |||||
posBeanList | Array | 否 | 签署位置信息 | |||||
posPage | String | 否 | 签署页码，若为多页签署，支持页码格 式”1-3,5” | |||||
posX | float | 否 | 签署位置 X 坐标，若为关键字定位， 相对于关键字的 X 坐标偏移量，默认 0 | |||||
posY | float | 否 | 签署位置 Y 坐标，若为关键字定位， 相对于关键字的 Y 坐标偏移量，默认 0 | |||||
key | String | 否 | 关键字，仅限关键字签署时有效，若为 关键字定位时，不可空 | |||||
scale | float | 否 | 印章展现宽度，将以此宽度对印章图片做同比缩放。 1) 为空： 按创建印章时指定的大小签署； 2) 不为空 印章宽度以传入参数为准 | |||||
signerAppAuto | JSON | 否 | 对接平台自身签署信息 当对接平台自身需要参与签署时包含此参数 | |||||
signOrder | int | 否 | 平台自身在整个签署流程中的签署顺 序，在需要进行有序签时指定 | |||||
autoSign | int | 否 | 是否静默签署，0 否，1 是，默认 0 | |||||
sealType | String | 否 | 指定签署印章类型空置不限类型 0：手绘印章 1：模板印章 多种印章类型以英文逗号分隔 | |||||
certType | int | 否 | 指定签署证书类型 1 长效云证书 2 事件证书 3 指纹证书 4 手机盾证书 5 ukey 证书 默认使用账户长效云证书签署 | |||||
docPosList | Array | 否 | 对接平台对应文档的签署位置 当需要指定签署位置或者签署人无需参与所有文档签署时包含该参数 默认所有签署者必须签署所有合同，位 置由签署人通过印章拖拽指定 | |||||
docId | String | 是 | 合同 id | |||||
signType | int | 否 | x章位置定位方式 1 关键字定位 2 坐标定位 3 骑缝盖章 | |||||
qrcodeSign | int | 否 | 签署印章是否包含签署任务查看二维码标识 0 否，1 是，默认为 0 另当签署类型为骑缝签和多页签时，该标识无效 | |||||
posBeanList | Array | 否 | 签署位置信息 | |||||
posPage | String | 否 | 签署页码，若为多页签署，支持页码格 式”1-3,5” | |||||
posX | float | 否 | 签署位置 X 坐标，若为关键字定位， 相对于关键字的 X 坐标偏移量，默认 0 | |||||
posY | float | 否 | 签署位置 Y 坐标，若为关键字定位， 相对于关键字的 Y 坐标偏移量，默认 0 | |||||
key | String | 否 | 关键字，仅限关键字签署时有效，若为 关键字定位时，不可空 | |||||
scale | float | 否 | 印章展现宽度，将以此宽度对印章图片做同比缩放。 1) 为空： | |||||
按创建印章时指定的大小签署； 2) 不为空 印章宽度以传入参数为准 |
响应参数：
参数名称 | 类型 | 必选 | 参数说明 | |
flowId | String | 是 | 流程 id | |
signUrlList | Array | 否 | 签署地址 | |
accountId | String | 是 | 待签署人的账户 id | |
signUrl | Array | 是 | 签署地址 | |
请求示例：
{
"businessScene":"买房子", "initiatorAccountId":"5b57da28b3e2451bb8018dd352087257", "signValidity":"65464896464648", "contractValidity":"65464896464648", "payer":"231797f94ce941449f677d67f9db0b1c", "autoInitiate":"1",
"signPlatform":"",
"noticeType":"1,2,3",
"redirectUrl":"", "docList":[
{
"docId":"96c8eb71841b4b1babf0dda6812154a1"
}
],
"recipientList":{ "signerList":[
{
"accountId":"20b02d406e204d4cb755c2e409062c00", "authorizationOrgId":"",
"signOrder":"1",
"autoSign":"1",
"sealType":"0",
"certType":"1", "docPosList":[
{
"docId":"96c8eb71841b4b1babf0dda6812154a1", "signType":"1",
"qrcodeSign":"1", "posBeanList":[
{
"posPage":"1",
"posX":"100",
"posY":"100",
"key":"",
"scale":""
}
]
}
]
}
]
60
}
}
返回示例：
{
"flowId":"123456789",
"signUrlList":[{ "accountId":"16464648", "signUrl":["http://"]
}]
}
4.9.2 执行合同签署
接口描述：
⚫ 如果在 5.5.1 接口中配置 autoInitiate=false，则签署任务进入准备状态。需要对接方主动调用该接口触发签署任务执行，即触发签署任务对签署人可见、对签署人发送签署通知或者执行静默签署
接口地址：
/sign/execute
请求参数：
参数名称 | 类型 | 必选 | 参数说明 |
flowId | String | 是 | 待启动执行的任务 Id |
响应参数：
直接根据返回状态码判断，无返回参数
请求示例：
{
"flowId":"65464896464648"
}
返回示例：
{
"errCode":0,
"msg":"SUCCESS"
}
4.9.3 撤销签署
接口描述：
⚫ 支持对接方通过签署任务 id 终止正在进行中的签署流程
接口地址：
/sign/revoke
请求参数：
参数名称 | 类型 | 必选 | 参数说明 |
flowId | String | 是 | 签署流程 id |
响应参数：
直接根据返回状态码判断，无返回参数
请求示例：
{
"flowId":"123456789"
}
返回示例：
{
"errCode":0,
"msg":"SUCCESS"
}
4.9.4 签署文件下载
接口描述：
⚫ 支持对接方通过签署任务 id 获取流程中已经完成签章的文件
接口地址：
/sign/download
请求参数：
参数名称 | 类型 | 必选 | 参数说明 |
flowId | String | 是 | 签署流程 id |
响应参数：
签署流中支持多个合同文件，故返回值为 JSONArray 结构，Array 中的元素包含以下内容：
参数名称 | 类型 | 必选 | 参数说明 |
docId | String | 是 | 合同 id |
docUrl | String | 是 | 文档获取地址，链接 30 分钟有效 |
请求示例：
{
"flowId":"123456789"
}
返回示例：
[
{"docId":"123456789",
"docUrl":"http://{donwoloadhost}/1.pdf"},
{"docId":"987654321", "docUrl":"http://
{donwoloadhost}/2.pdf"}
]
4.9.5 查询合同签署详情
接口描述：
⚫ 支持对接方通过签署任务 id 查询签署进度
接口地址：
/sign/docdetail
请求参数：
参数名称 | 类型 | 必选 | 参数说明 |
flowId | String | 是 | 签署流程 id |
响应参数：
参数名称 | 类型 | 必选 | 参数说明 | ||
flowId | String | 是 | 签署流程 id | ||
businessScene | String | 否 | 签署业务场景 | ||
initiatorAccountId | String | 否 | 发起人账号 id | ||
flowStatus | int | 是 | 签署任务状态 0-草稿、1-签署中、2-已完 成、3-已撤销、4-已终止、5-已过期 | ||
signValidity | String | 否 | 发起时指定的签署截止时间 | ||
startTime | String | 是 | 签署任务发起时间 yyyy-MM-dd HH:mm:ss | ||
endTime | String | 否 | 结束时间 yyyy-MM-dd HH:mm:ss | ||
signInfo | Array | 是 | 签署详情 | ||
docId | String | 是 | 合同 id | ||
docName | String | 是 | 合同名称 | ||
xxxxXxxxxx | Xxxxx | 否 | 签署状态信息 | ||
accountId | String | 是 | 签署人的 accountId | ||
authorizati onOrgId | String | 否 | 授权签署人进行代理签署的企业 id 当个人以企业角色进行签署时包含该参数 | |||
signStatus | int | 是 | 0-待签署、1 签署中、2 已完成、3 签署失 败、4 已拒签、5-待确认 | |||
recieveTime | String | 否 | 接收时间 yyyy-MM-dd HH:mm:ss | |||
signTime | String | 否 | 签署时间 yyyy-MM-dd HH:mm:ss | |||
signExplain | String | 否 | 签署人签署或拒签时，所做出的附加说明 等补充信息 |
请求示例：
{
"flowId":"123456789"
}
返回示例：
{
"flowId":"t73t7dgsugud", "businessScene":"购房场景", "initiatorAccountId":"464gd84hf855", "flowStatus":1,
"startTime":"2018-04-04 12:12:12",
"endTime":"2018-04-07 12:12:12",
"signInfo":[{ "docId":"f55g4df4h8f", "signDetail":[{
"accountId":"fg54fd4g8", "authorizationOrgId":"g87489fd4g8d", "signStatus":1,
"recieveTime":"2018-04-06 12:12:12",
"signTime":"2018-04-07 09:12:12"
}]
}]
}
4.10.1通知说明
由于文档签署涉及大量数字签名、文档操作等耗时操作，签署任务的执行采用异步方式进行，完成后通过回调的方式通知平台方签署结果，目前 e 签宝提供两种场景的回调通知：
场景一：在签署任务中某一个签署人完成签署或拒签时，通知对接平台该签署人的签署状态的更新。如一个需要xx和xx共同签署的合同，当xx签署完成时，e 签宝通知平台张三完成了其相关合同的签署。
场景二：在签署任务结束时（正常签署完成或拒签等原因导致的非正常结束时），e 签宝通知对接平台签署任务的状态。
回调地址需接入方在 e 签宝开放平台中进行统一配置，开放平台地址见第 3 章接入准备章节。
特别说明：平台方在通知接口的实现中，应尽可能采用异步处理的机制，减少通知接口调用的阻塞时间，e 签宝通知接口调用时间最长等待 2s。
e 签宝根据接口的HTTP 响应状态判断调用的结果，当 status >=200 && status < 400 时，认为通知成功；最多通知 6 次，每次通知间隔 0.5 小时。
4.10.2通知安全机制
通知接口调用统一采用基于应用 ID（ProjectID） 和应用 Secret（ProjectSecret）的 HMAC-SHA256 的签名验签机制。具体详见第 3 和 4 章节内容。
4.10.3签署人签署状态更新通知
通知参数：
参数名称 | 类型 | 必选 | 参数说明 |
action | String | 是 | 标记该通知的业务类型，该通知固定 为：SIGN_FLOW_UPDATE |
accountId | String | 是 | 签署人的 accountId |
flowId | String | 是 | 签署任务 id |
docId | String | 是 | 签署完成的 docId |
signTime | String | 是 | 签署时间或拒签时间 格式 yyyy-MM-dd HH:mm:ss | |
signResult | int | 是 | 签署结果 2 - 签署完成 3-失败 4 - 拒签 | |
resultDescription | String | 否 | 拒签或失败时，附加的原因描述 |
4.10.4签署任务结束通知
通知参数：
参数名称 | 类型 | 必选 | 参数说明 |
action | String | 是 | 标记该通知的业务类型，该通知固定 为：SIGN_FLOW_FINISH |
businessScence | String | 否 | 签署业务场景描述 |
flowId | String | 是 | 签署任务 id |
flowStatus | int | 是 | 可能存在的任务状态： 2 已完成: 所有签署人完成签署 3 已撤销: 发起方撤销签署任务 4 已终止: 至少一个签署人拒签或通过重试不可恢复的签署失败 5 已过期: 超时未签署 |
statusDescription | String | 否 | 当流程异常结束时，附加终止原因描述 |
createTime | String | 是 | 签署任务发起时间 格式 yyyy-MM-dd HH:mm:ss |
endTime | String | 是 | 签署任务结束时间 格式 yyyy-MM-dd HH:mm:ss |
5 FAQ
证照类型值 | 类型说明 |
10 | 企业组织机构代码 |
11 | 企业统一社会信用代码 |
12 | 企业工商注册号 |
证照类型值 | 类型说明 |
13 | 护照 |
14 | 军人身份证 |
15 | 社会保障卡 |
16 | 武装警察身份证件 |
17 | 港澳居民往来内地通行证 |
18 | 台湾居民来往大陆通行证 |
19 | 中国大陆居民身份证 |
20 | 中国大陆居民户口簿 |
21 | 中国大陆居民临时身份证 |
22 | 外国人永久居留身份证 |