一步发起签署

接口地址 /api/v2/signflows/createFlowOneStep

请求方式 POST

接口描述

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

请求参数

参数名称	说明	参数类型	是否必须	类型
attachments	附件信息	body	false	array
+--fileId	附件Id	body	true	string
+--attachmentName	附件名称	body	true	string
copiers	抄送人人列表	body	false	array
+--copierAccountId	参与人account id	body	true	string
+--copierIdentityAccountType	参与主体类型, 0-个人, 1-企业, 默认个人	body	true	int32
+--copierIdentityAccountId	参与主体账号id	body	false	string
docs	待签文档信息	body	false	arra
+--fileId	文档id	body	true	string
+--fileName	文档名称,默认文件名称	body	false	string
+--encryption	是否加密，0-不加密，1-加，默认0	body	false	int32
+--filePassword	文档密码, 如果encryption值为1, 文档密码不能为空，默认没有密码	body	false	string
flowInfo	流程基本信息	body	false	object
+--autoArchive	是否自动归档，默认false。	body	false	boolean
+--autoInitiate	是否自动开启，默认false。	body	false	boolean
+--businessScene	业务场景	body	true	string
+--contractRemind	文件到期前，提前多少小时回调提醒续签，小时（时间区间：1小时——15天），默认不提醒	body	false	int32
+--contractValidity	文件有效截止日期,毫秒，默认不失效	body	false	int64
+--flowConfigInfo	任务配置信息	body	false	object
+--+--noticeDeveloperUrl	通知开发者地址	body	false	string
+--+--noticeType	通知方式，可选择多种通知方式，逗号分割，1-短信，2-邮件。默认1	body	false	string
+--+--redirectUrl	签署完成重定向地址	body	false	string
+--+--signPlatform	签署平台，可选择多种签署平台，逗号分割，1-开放服务h5，2-支付宝签，默认值1	body	false	string
+--initiatorAccountId	发起方账户id	body	false	string
+--initiatorAuthorizedAccountId	发起方主体id	body	false	string
+--remark	流程备注	body	false	string
+--signValidity	签署有效截止时间，毫秒，默认不失效	body	false	int64
signers	签署方信息	body	false	array
+--platformSign	是否平台自动签署，默认为对接平台的用户签署	body	false	boolean
+--signOrder	签署方签署顺序，默认1,且不小于1，顺序越小越先处理	body	false	int32
+--signerAccount	签署方账号信息（平台自动签署时忽略本参数）	body	false	object
+--+--signerAccountId	签署操作人个人账号标识，即操作本次签署的个人	body	false	string
+--+--authorizedAccountId	签约主体账号标识，即本次签署对应任务的归属方，默认是签署操作人个人	body	false	string
+--signfields	签署文件信息	body	false	array
+--+--autoExecute	是否自动执行，默认false（如果平台自动签署，必须设置为true）	body	false	boolean
+--+--actorIndentityType	机构签约类别，当签约主体为机构时必传：2-机构盖章；	body	false	string
+--+--fileId	文件fileId	body	true	string
+--+--sealId	印章id	body	false	string
+--+--sealType	签署方式，个人签署时支持多种签署方式，0-手绘签名，1-个人签章盖章，多种类型时逗号分割，为空不限制	body	false	string
+--+--signType	签署类型，0-不限，1-单页签署，2-骑缝签署，默认1	body	false	int32
+--+--posBean	签署区位置信息（signType为1时, 页码和XY坐标不能为空, signType为2时, 页码和Y坐标不能为空）	body	false	object
+--+--+--posPage	页码信息，当签署区signType为2时, 页码可以'-'分割指定页码范围, 其他情况只能是数字	body	false	string
+--+--+--posX	x坐标	body	false	float
+--+--+--posY	y坐标	body	false	float
+--+--width	签署区的宽度	body	false	int32
+--+--signDateBeanType	是否需要添加签署日期，0-禁止 1-必须 2-不限制，默认0	body	false	int32
+--+--signDateBean	签章日期信息	body	false	SignDateBean
+--+--+--fontSize	签章日期字体大小,默认12	body	false	int32
+--+--+--format	签章日期格式，默认 yyyy-MM-dd HH: mm :ss	body	false	string
+--+--+--posPage	页码信息，当signDateBeanType为1时，代表签署的印章必须展示签署日期，默认放在印章正下方，签署人可拖拽日期到当前页面的其他位置，如果发起方指定签署位置的同时，需要同时指定日期盖章位置，则需传入日期盖章页码（与印章页码相同），在传入X\Y坐标即可。	body	false	int32
+--+--+--posX	x坐标，默认0	body	false	float
+--+--+--posY	y坐标，默认0	body	false	float
+--thirdOrderNo	第三方流水号	body	false	string

请求示例

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

{
 "attachments":[
        {
            "attachmentName":"1",
            "fileId":"317014460ef247d59f8937e11318c6cf"
        }
    ],
  "docs": [
    {

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

    }
  ],
  "copiers": [
    {
      "copierAccountId": "93659d99bdbf4ca4a019c61cab3e4eab",
      "copierIdentityAccountId": "93659d99bdbf4ca4a019c61cab3e4eab",
      "copierIdentityAccountType": 0
    }
  ],  
  "flowInfo": {
    "autoArchive": true,
    "autoInitiate": true,
    "businessScene": "创建签署流程样例",
    "contractRemind": 1,
    "contractValidity": 1601049600000,
    "flowConfigInfo": {
      "noticeDeveloperUrl": "http://101.37.27.38:1110/notice/signature",
      "noticeType": "1,2,3",
      "redirectUrl": "",
      "signPlatform": "1,2"
    },
    "initiatorAccountId": "",
    "initiatorAuthorizedAccountId": "",   
    "remark": "",
    "signValidity": 1601049600000
  },
  "signers": [
      {
      "platformSign": true,
      "signOrder": 1,
      "signfields": [
        {
          "autoExecute": true,
          "fileId": "317014460ef247d59f8937e11318c6cf",
          "posBean": {
            "posPage": "1",
            "posX": 440,
            "posY": 440
          },
          "sealType": "",
          "sealId": "",
          "signType": 1,
          "width": 150,
          "signDateBeanType": 0,
          "signDateBean": {
            "fontSize": 0,
            "format": "",
            "posPage": 0,
            "posX": 0,
            "posY": 0
            },
           }
        }
      ],
      "thirdOrderNo": "111"
    }
  ]
}

响应参数

参数名称	说明	类型
code	错误码	int32
data	业务信息	流程创建响应数据
+--flowId	流程id	string
message	错误信息	string

响应示例

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

响应状态

状态码	说明	schema
200	OK	通用返回结果«流程创建响应数据»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

错误码

错误码	错误信息	错误原因
1437511	文档不存在，fileId:XXX	签署区里的fileId为空或fileId无效
1437306	XXXX:签署页码超出文档页数	签署区的页码大于文档页数
1435002	未定义的signType	签署类型无效, signType可支持4种值, 0-不限, 1-单页签署, 2-骑缝签, 4-关键字签署
	未定义的actorIndentityType	主体类型无效, 0-个人主体, 1- 机构主体
	缺少签署主体信息	actorIndentityType为1场景下,authorizedAccountId值为空
	未定义的sealType	印章类型无效, 0-手绘印章，1-模版印章，为空不限制
	缺少签署印章数据	签署区的assignedSeal值为true场景下, 印章数据为空
	位置信息为空	签署区的assignedPosbean值为true场景下, 签署坐标信息为空
	单页签署：必须指定正确的page、x、y	单页签署没有指定页码和XY轴坐标
	关键字签署：必须指定keyword	关键字签署的签署区关键字信息为空
	骑缝签署：必须指定y	骑缝签的签署区没有指定y轴坐标
	骑缝签署：必须满足'-'分割	骑缝签的签署区指定的页码格式不对, 页码要以'-'分隔, 比如1-5
	签署区设置自动执行，没有指定印章	签署区的autoExecute值为true但是没有指定印章信息
	签署区设置自动执行，签署主体不允许为空	签署区的autoExecute值为true但是没有指定签署主体信息
	签署区设置自动执行，签署类型错误	签署区的autoExecute值为true但是指定的签署类型无效, 有效的签署类型为: 1-单页签署, 2-骑缝签, 4-关键字签署

一步发起签署

一步发起签署

results matching ""

No results matching ""