接口描述
创建签署流程，一个签署流程目前最多只支持添加300个签署区
注：
（1）一个签署流程目前最多只支持添加300个签署区
（2）因Windows操作系统中文件名称不支持个别特殊字符，现调整businessScene字段不支持以下9个字符
/ \ : * " < > | ？以及所有emoji表情，详见文件名称特殊字符限制
点击查看具体更新日志
接口
/v1/signflows
请求方式
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 |
请求参数
展开全部参数参数名称 | 类型 | 必选 | 参数类型 | 参数说明 | |
autoArchive | boolean | 否 | body | 是否自动归档，默认false； 如设置为true，则在调用签署流程开启后，当所有签署人签署完毕，系统自动将流程归档，状态变为“已完成”状态； 如设置为false，则在调用流程开启后，需主动调用签署流程归档接口，将流程状态变更为“已完成”；已完成的流程才可下载签署后的文件 | |
businessScene | string | 是 | body | 本次签署流程的文件主题名称 注：不可含有以下9个特殊字符：/ \ : * " < > | ？以及所有emoji表情 | |
configInfo | object | 否 | body | 任务配置信息 | |
noticeDeveloperUrl | string | 否 | body | 回调通知地址 | |
noticeType | string | 否 | body | 签署通知方式， 默认方式：1。同时支持多种通知方式，用逗号分割。 1-短信，2-邮件。 （如果套餐内带“分项”字样，请确保开通【电子签名流量费（分项）认证】中的子项：【短信服务】，否则短信通知收不到） 注：短信或者邮件获取到的签署链接，有效期默认30天；如果客户需要不通知，可以设置noticeType="",详细规则【请点击】 | |
redirectUrl | string | 否 | body | 签署完成重定向地址,默认签署完成停在当前页面 | |
signPlatform | string | 否 | body | 签署平台，逗号分割，1-开放服务h5，2-支付宝签 ，默认值1,2 | |
personAvailableAuthTypes | list | 否 | body | 个人页面显示实名认证方式 PSN_BANK4_AUTHCODE个人银行卡四要素认证 PSN_TELECOM_AUTHCODE个人运营商三要素认证 PSN_FACEAUTH_BYURL个人刷脸认证
| |
personAuthAdvancedEnabled | list | 否 | body | 指定通过银行卡认证或运营商认证方式时，是否使用详情版，如指定则核验失败可返回具体不匹配信息，传空默认为普通版。 PSN_BANK4_AUTHCODE个人银行卡四要素认证 PSN_TELECOM_AUTHCODE个人运营商三要素认证 注：详情版，需要单独购买，具体购买方式请咨询e签宝工作人员 普通版，信息比对核验失败，不会返回具体的不匹配信息 | |
orgAvailableAuthTypes | list | 否 | body | 企业页面显示实名认证方式 ORG_BANK_TRANSFER 组织机构对公账户打款认证 ORG_ZM_AUTHORIZE 企业芝麻认证ORG_LEGAL_AUTHORIZE 组织机构法定代表人授权书签署认证 | |
willTypes | list | 否 | body | 页面指定意愿认证方式，可指定类型如下： CODE_SMS 短信验证码 FACE_ZHIMA_XY 支付宝刷脸 FACE_TECENT_CLOUD_H5 腾讯云刷脸 SIGN_PWD 签署密码 以下方式需联系交付顾问开通后方可使用： FACE_FACE_LIVENESS_RECOGNITION 快捷刷脸 FACE_WE_CHAT_FACE 微信小程序刷脸 FACE_AUDIO_VIDEO_DUAL 支付宝智能视频认证 VIDEO_WE_CHAT_VIDEO_DUAL 微信智能视频认证 | |
faceVideoTemplate | string | 否 | body | 视频认证模板id，请联系交付提供 | |
batchDropSeal | boolean | 否 | body | 签署页是否显示“一键落章”按钮， 默认显示。 关闭显示 - false 显示 - true | |
countdown | int32 | 否 | body | 签署页提交倒计时，单位为秒，不传默认为0，最大999 | |
redirectDelayTime | int | 否 | body | 签署完成重定向跳转延迟时间，默认3。 0-不展示签署完成结果页，签署完成直接跳转重定向地址 3-展示签署完成结果页，倒计时3秒后，自动跳转重定向地址 注：当redirectUrl不传的情况下，该字段无需传入，默认签署完成结果页不跳转 | |
mobileShieldWay | string | 否 | body | 是否使用e签盾签署，默认为1. 1-不使用e签盾； 2-使用e签盾 注：使用e签盾签署后，签署平台默认提示跳转e签宝app进行签署 更新日志：点此了解 | |
contractValidity | int64 | 否 | body | 文件有效截止日期,毫秒，默认不失效; 该参数设置的时间若到期，则会触发【流程文件过期通知】 | |
contractRemind | int32 | 否 | body | 文件到期前，提前多少小时回调提醒续签，小时（时间区间：1小时——15天），默认不提醒； | |
signValidity | int64 | 否 | body | 签署有效截止日期,毫秒，默认不失效； 注：超过签署有效截止时间，则无法继续签署。 若该参数设置的时间到期，则会触发【流程结束回调通知】 | |
initiatorAccountId | string | 否 | body | 发起人账户id，即发起本次签署的操作人个人账号id；如不传，默认由对接平台发起 | |
initiatorAuthorizedAccountId | string | 否 | body | 发起方主体id，如存在个人代机构发起签约，则需传入机构id；如不传，则默认是对接平台 | |
公共响应参数
参数名称 | 类型 | 必选 | 参数说明 |
code | int | 是 | 业务码，0表示成功 |
message | string | 否 | 信息 |
data | object | 否 | 业务信息 |
响应参数
参数名称 | 类型 | 必选 | 参数说明 |
flowId | string | 是 | 流程id |
请求示例
POST https://openapi.esign.cn/v1/signflows{
"autoArchive":false,
"businessScene":"xx企业签订劳动合同",
"configInfo":{
"noticeDeveloperUrl":"http://172.10.XX.XX:8080/notify/esign",
"noticeType":"1,2",
"redirectUrl":"http://172.10.XX.XX:8080/h5/forword",
"signPlatform":"1",
"mobileShieldWay":"1",
"willTypes":["FACE_ZHIMA_XY"],
"personAvailableAuthTypes":["PSN_FACEAUTH_BYURL"],
"batchDropSeal":true,
"orgAvailableAuthTypes":["ORG_BANK_TRANSFER"],
"personAuthAdvancedEnabled":["PSN_BANK4_AUTHCODE"],
"countdown":5
},
"contractRemind":360,
"contractValidity":1592386042000,
"signValidity":1592386042000,
"initiatorAccountId":"40eb61714d9e49088bac7a3c56d69d66",
"initiatorAuthorizedAccountId":"40eb61714d9e49088bac7a3c56d69d66"
}响应示例
{
"code":0,
"message":"成功",
"data":{
"flowId":"429b1d3038854cabbcdac0a63d7e4c0d"
}
}错误码
错误码 | 错误描述 | 解决方案 |
401 | 1.token过期了 2.header请求头不正确 3.apiurl和应用ID环境不对应，例如apiurl是模拟环境，应用ID是正式环境的 |
我要纠错