一步发起签署

接口描述

聚合创建流程接口，一步添加待签文件、相关附件、流程基本信息、签署方。支持签署流程自动开启和结束。

【提示】

1、该文件是否需要签署。如果添加的文件只是给签署人阅读，不做签署，建议将该文件以附件的形式进行添加，通过字段attachments传入附件信息；

2、通过字段docs添加的签署文件，将按照正常计费模式扣除合同份额。

3、因Windows操作系统中文件名称不支持个别特殊字符，现调整businessScene、attachmentName、fileName字段不支持以下9个字符/ \ : * " < > | ？以及所有emoji表情，详见文件名称特殊字符限制

4、单个签署流程所添加的待签署文件大小总和不要超过500M，待签署文件个数不超过50个，单个文件的大小不要超过20M，单个文件的单页大小不要超过9M，单个签署流程所添加的签署区不要超过300个，详见文件大小规则说明

点击查看具体更新日志

接口

/api/v2/signflows/createFlowOneStep

请求方式

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

请求参数

展开全部参数参数名称				类型	必选	参数类型	参数说明
flowInfo				object	是	body	流程基本信息
	autoArchive			boolean	否	body	全部签章后流程自动结束，默认false。 true - 自动结束 false - 非自动结束 false时需要开发者调用【签署流程结束】接口结束流程
	autoInitiate			boolean	否	body	是否自动开启，默认false。
	businessScene			string	是	body	本次签署流程的文件主题名称注：名称不支持以下9个字符：/ \ : * " < > \| ？
	contractRemind			int32	否	body	文件到期前，提前多少小时回调提醒续签，小时（时间区间：1小时——15天），默认不提醒
	contractValidity			int64	否	body	文件有效截止日期,毫秒，默认不失效
	flowConfigInfo			object	否	body	任务配置信息
		noticeDeveloperUrl		string	否	body	通知开发者地址。（e签宝服务器主动通过POST方式通知开发者指定服务器的页面路径（http/https））通知说明见【通知回调】模块
		noticeType		string	否	body	通知方式，可选择多种通知方式，逗号分割 1-短信，2-邮件。默认1 （请确保开通【身份核验能力】的子服务项：【短信服务】，否则短信通知收不到）注：短信或者邮件获取到的签署链接，有效期默认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 组织机构法定代表人授权书签署认证 LEGAL_REP_AUTH 法定代表人认证注：（1）法定代表人本人认证的方式默认都是在页面存在的，无法去掉（2）当只希望用户选择【法定代表人认证】一种方式时，此参数仅传入 LEGAL_REP_AUTH 即可
willTypes		list	否	body	页面指定意愿认证方式，可指定类型如下： CODE_SMS 短信验证码 FACE_ZHIMA_XY 支付宝刷脸 FACE_TECENT_CLOUD_H5 腾讯云刷脸以下四种方式需联系交付顾问开通后方可使用： 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不传的情况下，该字段无需传入，默认签署完成结果页不跳转
initiatorAccountId			string	否	body	发起方账户ID
initiatorAuthorizedAccountId			string	否	body	发起方主体ID
signValidity			int64	否	body	签署有效截止时间，毫秒，默认不失效注：超过签署有效截止时间，则无法继续签署。
signers				array	是	body	签署方信息 *类型为数组，多方签署建议添加多个对象注：签署方字段设置规则【请点击】
		platformSign			boolean	否	body	是否平台自动签署，默认false false-为对接平台的用户签署 true-平台方自动签署注：仅appId所属的平台企业签署可以传true
		agreeAutoSign			boolean	否	body	个人用户是否需要静默签署授权，默认false false-不需要 true-需要注：该功能需要联系e签宝技术/业务人员开通，该字段才可以传true；如传true，则该用户在当前签署页面内需要勾选同意静默签署服务协议，勾选同意并完成本次签署后，在协议有效内可使用静默落章功能；静默签署：后续在协议约定时间内（默认365天），在当前开发者appId下，开发者使用autoExecute:true，即可直接帮助当前用户完成签署，无需唤起e签宝签署页面；与agreeSkipWillingness不可同时传true
		agreeSkipWillingness						个人用户是否需要授权免意愿快捷签署，默认false false-不需要 true-需要注：该功能需要联系e签宝技术/业务人员开通，该字段才可以传true；如传true，则该用户在当前签署页面内需要勾选同意快捷签署服务协议，勾选同意并完成本次签署后，在协议有效期内可使用快捷签署功能；快捷签署：后续当前用户在协议约定时间内（默认7天）再次在当前开发者appId、当前终端设备下、并在e签宝的页面内签署即可免除意愿认证，直接签署成功。与agreeAutoSign不可同时传true
		signOrder			int32	否	body	签署方签署顺序，默认1,且不小于1，顺序越小越先处理
		signerAccount			object	否	body	签署方账号信息（平台方自动签署时，无需传入该参数）
			signerAccountId		string	否	body	签署操作人个人账号标识，即操作本次签署的个人注：个人/企业用户手动签署时，需传入签署的个人/经办人的签署账号ID（【创建个人签署账号】接口获取）
			authorizedAccountId		string	否	body	签约主体账号标识，即本次签署对应任务的归属方，默认是签署操作人个人注：企业用户手动签署时，需传入签署的机构的签署账号ID（【创建机构签署账号】接口获取）
noticeType			string	否	body	通知方式，可选择多种通知方式，逗号分割 1-短信，2-邮件（请确保开通【身份核验能力】的子服务项：【短信服务】，否则短信通知收不到）注：可以通过此字段控制单个签署方的通知方式，不同的签署方可以设置不同的通知方式
willTypes			array	否	body	指定该签署人的意愿认证方式若flowConfigInfo下也传入willTypes，以 signerAccount下此参数的传值优先支持类型如下： CODE_SMS* 短信验证码 FACE_ZHIMA_XY 支付宝刷脸 FACE_TECENT_CLOUD_H5 腾讯云刷脸以下四种方式需联系交付顾问开通后方可使用： FACE_FACE_LIVENESS_RECOGNITION 快捷刷脸 FACE_WE_CHAT_FACE 微信小程序刷脸 FACE_AUDIO_VIDEO_DUAL 支付宝智能视频认证 VIDEO_WE_CHAT_VIDEO_DUAL 微信智能视频认证
signfields			array	是	body	签署方的签署区列表数据
		assignedPosbean		boolean	否	body	表示签署过程中，是否固定指定的签署区位置，默认为true。 true-固定签署区位置且无法移动， false-不固定签署区位置且签署时可自由移动注：当signType为1或者2时，该字段才会生效
		autoExecute		boolean	否	body	是否自动执行，默认false（如果自动签署，必须设置为true）
	actorIndentityType		int32	否	body	机构签约类别，当签约主体为机构时必传： 2-机构盖章注： 1、签署主体是个人时，无需传入该参数，传入会导致无法正常签署 2、签署主体是企业时，该字段必传，传入2
	fileId		string	是	body	文件fileID
	sealId		string	否	body	印章ID 注：（1）当印章ID为空时，取appId对应企业的默认印章；（2）如果开通了实名签，企业和个人手动签署场景均不支持指定印章；
	sealType		string	否	body	签署方式，个人签署时支持多种签署方式， 0-手绘签名，1-模板印章签名，多种类型时逗号分割，为空不限制
	handDrawnWay		string	否	body	手绘签名方式 0-普通手绘签名 1-AI校验手绘签名多种类型时逗号分割，为空只有普通手绘签名
	signType		int32	否	body	签署类型，0-不限，1-单页签署，2-骑缝签署，默认1
	posBean		object	否	body	签署区位置信息。 signType为0时，本参数无效； signType为1时, 页码和XY坐标不能为空,； signType为2时, 页码和Y坐标不能为空
		posPage	string	否	body	页码信息，当签署区signType为2时, 页码可以'-'分割指定页码范围, 传all代表全部页码。其他情况只能是数字
		posX	float	否	body	x坐标，坐标为印章中心点注：印章图片尺寸和坐标计算方式【请点击】开放平台拖章定位工具：【请点击】根据关键字辅助定位接口【请点击】
		posY	float	否	body	y坐标，坐标为印章中心点
width		int32	否	body	签署区宽度（默认印章的宽度）
signDateBeanType		int 32	否	body	是否需要添加签署日期，0-禁止 1-必须 2-不限制，默认0
signDateBean		object	否	body	签署日期信息
	fontSize	int32	否	body	签章日期字体大小（默认值12px）
	format	string	否	body	签章日期格式，支持的格式： yyyy年MM月dd日（默认值） yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	posPage	int32	否	body	页码信息注：autoExecute是否自动执行为true时，并且需要展示签署日期，则需要指定日期盖章页码，默认当前页
	posX	float	否	body	x坐标，坐标点为日期左下角注：autoExecute是否自动执行为true时，并且需要展示签署日期，则需要指定日期盖章位置，默认为0
	posY	float	否	body	y坐标，坐标点为日期左下角注：autoExecute是否自动执行为true时，并且需要展示签署日期，则需要指定日期盖章位置，默认为0
thirdOrderNo			string	否	body	第三方流水号
docs				array	是	body	待签署文件信息
	fileId			string	是	body	待签署文件id
	fileName			string	否	body	待签署文件名称（必须带上文件扩展名，不然会导致后续发起流程校验过不去示例：合同.pdf ）；注意：（1）该字段的文件后缀名称和真实的文件后缀需要一致。比如上传的文件类型是word文件，那该参数需要传“xxx.docx”，不能是“xxx.pdf” （2）文件名称不支持以下9个字符：/ \ : * " < > \| ？
	encryption			int32	否	body	是否加密，0-不加密，1-加密，默认0注意：只支持编辑加密的PDF文件，且签署区设置的时候只有平台自动签署和签署方自动签署场景支持对加密文件盖章，手动签署区不支持
	filePassword			string	否	body	文件密码, 如果encryption值为1, 文件密码不能为空，默认没有密码
attachments				array	否	body	附件信息（仅用于查看，不需要签署的文档）
	fileId			string	是	body	附件Id
	attachmentName			string	是	body	附件名称注：文件名称不支持以下9个字符： / \ : * " < > \| ？
copiers				array	否	body	抄送人列表注：抄送人指不参与签署，只查看签署文件的人
	copierAccountId			string	是	body	抄送人accountId
	copierIdentityAccountType			int32	是	body	抄送主体类型, 0-个人, 1-企业
	copierIdentityAccountId			string	否	body	抄送主体账号id

公共响应参数

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

响应参数

参数名称	类型	必选	参数说明
flowId	string	否	流程ID

请求示例

POST https://openapi.esign.cn/api/v2/signflows/createFlowOneStep

{
 "attachments":[
        {
            "attachmentName":"附属材料",
            "fileId":"ef08e9016806421e94f831a9dxx"
        }
    ],
  "docs": [
    {

      "fileId": "ef08e9016806421e94f831a9d701xx",
      "fileName": "个人借贷合同.pdf"

    }
  ],
  "copiers": [
    {
      "copierAccountId": "93659d99bdbf4ca4a019c61cabxx",
      "copierIdentityAccountId": "93659d99bdbf4ca4a019c61cab3xx",
      "copierIdentityAccountType": 0
    }
  ],  
  "flowInfo": {
    "autoArchive": true,
    "autoInitiate": true,
    "businessScene": "创建签署流程样例",
    "contractRemind": 1,
    "contractValidity": 1601049600000,
    "flowConfigInfo": {
      "noticeDeveloperUrl": "http://101.xx.xx.xx:8021/notice/esign",
      "noticeType": "1,2,3",
      "redirectUrl": "",
      "signPlatform": "1,2",
      "willTypes":["FACE_ZHIMA_XY"],
      "personAvailableAuthTypes":["PSN_FACEAUTH_BYURL"],
      "batchDropSeal":true,
      "orgAvailableAuthTypes":["ORG_BANK_TRANSFER"],
      "personAuthAdvancedEnabled":["PSN_BANK4_AUTHCODE"],
      "countdown":5
    },
    "signValidity": 1601049600000
  },
  "signers": [
      {
      "platformSign": true,
      "signOrder": 1,
      "signfields": [
        {
          "autoExecute": true,
          "actorIndentityType":2,
          "fileId": "ef08e9016806421e94f831a9d7xxx",
          "posBean": {
            "posPage": "1",
            "posX": 440,
            "posY": 440
          },
          "sealType": "",
          "signDateBean": {
              "fontSize": 12,
              "format": "yyyy年MM月dd日"
          },
          "signType": 1,
          "width": 150
        }
      ],
      "thirdOrderNo": "111"
    }
  ]
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "flowId": "bd465171b2a84434ad80bf416957cxxx"
    }
}

错误码

错误码	错误描述	解决方案
1437511	文档不存在，fileId:XXX	签署区里的fileId为空或fileId无效
1437306	XXXX:签署页码超出文档页数	签署区的页码大于文档页数
401		1.token过期了 2.header请求头不正确 3.apiurl和应用ID环境不对应，例如apiurl是模拟环境，应用ID是正式环境的