发起签署流程（按账号ID）

文档变更

2022年时，一步发起签署变为发起签署流程（按账号ID），仅中文名称变更，其功能保持不变。

接口描述

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

【提示】

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

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

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

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

5、签署过程中除了印章使用员和印章审批员之外的企业用户，在使用企业印章时，都会触发用印审批。

接口地址&请求方式

接口地址：/api/v3/signflows/createFlowOneStep

请求方式：POST

请求头格式

具体请求头格式结构，请点击查看公共参数说明。

请求参数

展开全部参数参数名称					类型	必选	参数类型	参数说明（左右拖动查看完整描述）
flowInfo					object	是	body	本次签署流程的基本信息
	businessScene				string	是	body	本次签署流程的文件主题名称查询此参数的效果示例注：名称不支持以下9个字符：/ \ : * " < > \| ？以及所有emoji表情
	autoArchive				boolean	否	body	全部签章后流程自动完结，默认false。 true - 自动完结 false - 非自动完结 false时需开发者主动调用【完结签署流程】接口完结流程
	autoInitiate				boolean	否	body	是否自动开启，默认false。
	signValidity				int64	否	body	本次签署流程的截止时间。时间戳格式，单位：毫秒，默认永久有效。查询此参数的效果示例注：超过签署有效截止时间，则无法继续签署。
	contractValidity				int64	否	body	本次签署文件的到期时间。时间戳格式，单位：毫秒，默认永久有效。查询此参数的效果示例注：只有设置了contractValidity，才能设置续签提醒时间contractRemind。
	contractRemind				int32	否	body	本次签署的续签提醒时间。单位：小时，默认不提醒。注：时间区间[1-360]，可通过异步通知等方式触发续签通知
	initiatorAccountId				string	否	body	发起人账户id（需经过认证授权），即发起本次签署的操作人个人账号id；如不传，默认由对接平台发起
	initiatorAuthorizedAccountId				string	否	body	发起方主体id（需经过认证授权），如存在个人代机构发起签约，则需传入机构id；如不传，则默认是对接平台
	flowConfigInfo				object	否	body	本次签署流程的任务信息配置
	identificationConfig			object	否	body	认证配置项
		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，请联系交付顾问提供
notifyConfig			object	否	body	通知配置项
		noticeDeveloperUrl		string	否	body	回调通知接收地址。（e签宝服务器主动通过POST方式通知开发者指定服务器的页面路径（http/https））通知说明见【通知回调】模块
		noticeType		string	否	body	签署通知方式，默认方式：1。同时支持多种通知方式，用逗号分割。 1-短信,2-邮件。（如果套餐内带“分项”字样，请确保开通【电子签名流量费（分项）认证】中的子项：【短信服务】，否则短信通知收不到）注：（1）短信或者邮件中的签署链接，有效期为30天；如客户不需要通知，请设置noticeType="" 详细规则【请点击】（2）短信或邮件中的签署链接依然需要登录框。
		examineNotice		boolean	否	body	通知给企业印章用印审批人员的通知类型，按照账号中的手机号或邮箱的填写情况进行通知。不传值默认取noticeType配置的通知方式 true - 发送消息（短信+邮件+e签宝官网站内信）（如果套餐内带“分项”字样，请确保开通【电子签名流量费（分项）认证】中的子项：【短信服务】，否则短信通知收不到） false - 不发送消息
signConfig			object	否	body	签署配置项
	redirectUrl		string	否	body	签署完成后，重定向跳转地址（http/https）。
	signPlatform		string	否	body	签署平台，默认值1,2。可选择多种签署平台，逗号分割。 1-H5网页版方式进行签署； 2-跳转支付宝(移动端)或支付宝扫码进行签署(PC端)。
	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进行签署更新日志：点此了解
signers					array	是	body	签署方信息 *类型为数组，多方签署建议添加多个对象注：签署方中具体字段设置规则【请点击】
	platformSign				boolean	否	body	是否平台方自动签署，默认false true-平台方自动签署 false-平台用户签署
	signOrder				int32	否	body	签署顺序，默认1，数值需为大于等于1的整数。数值越小越优先处理。
	forceReadTime				int32	否	body	签署强制阅读时间, 单位为秒，不传默认为0，最大999 注：（1）签署页提交倒计时，仅限平台用户手动签署时可用。（2）与流程中的签署配置项countdown字段作用相同，只是此字段在签署人维度控制，优先级更高。
	signerAccount				object	否	body	签署方账号信息（平台方自动签署时，无需传入该参数；平台用户签署时，该参数必传）
		signerAccountId			string	否	body	签署操作人个人账号标识，即操作本次签署的个人注：（1）传入e签宝SaaS官网的账号ID，即通过【获取认证链接】操作认证后生成的账号ID。
		authorizedAccountId			string	否	body	签约主体账号标识，即本次签署对应任务的归属方，默认是签署操作人个人注：（1）传入e签宝SaaS官网的账号ID，即通过【获取认证链接】操作认证后生成的账号ID。（2）如果是企业机构签署，请传企业机构账号orgId。
noticeType			string	否	body	通知方式，可选择多种通知方式，逗号分割 1-短信，2-邮件（如果套餐内带“分项”字样，请确保开通【电子签名流量费（分项）认证】中的子项：【短信服务】，否则短信通知收不到）注：（1）可以通过此字段控制单个签署方的通知方式，不同的签署方可以设置不同的通知方式。详细规则【请点击】（2）短信或邮件中的签署链接依然需要登录框。
signfields				array	是	body	签署方的签署区列表数据
		assignedPosbean			boolean	否	body	表示签署过程中，是否固定指定的签署区位置，默认为true。 true-固定签署区位置且无法移动， false-不固定签署区位置且签署时可自由移动注：当signType为1或者2时，该字段才会生效
	autoExecute			boolean	否	body	是否自动执行签署，默认false true-自动签署， false-手动签署。注： 1、平台方自动签署时，该字段必传，传入true； 2、个人用户不支持自动落章； 3、非平台方企业需要做印章授权给平台后才可自动落章，详细参考【印章授权说明】。
	actorIndentityType			int32	否	body	企业主体签约类型：0-个人盖章，2-机构盖章；默认是0 注： 1、签署主体是个人时，无需传入该参数，或者传0 2、签署主体是企业时，该字段必传，传入2
	fileId			string	是	body	待签署文件ID 可通过【上传本地文件】获取fileId。
	sealIds			list	否	body	印章ids，用于手动签署时，指定企业印章进行展示，实现手动选择印章进行签署 (1)只支持签约主体为企业时指定印章，通过e签宝官网获取对应实名主体下的印章编号。 (2)支持传入多个印章id，入参格式：sealIds:["印章id1","印章id2",....]
	sealId			string	否	body	印章ID 通过e签宝官网获取对应实名主体下的印章编号。注：（1）当印章ID为空时，取appId对应企业的默认印章；（2）平台方自动盖章签署时，仅限传入企业章，不支持指定企业法定代表人印章；（3）平台方自动盖章签署时，如果指定企业授权印章，签署后的签名信息，印章样式和数字证书均为授权企业主体所有，详细参考【印章授权说明】
	sealBizTypes			string	否	body	指定业务印章类型（仅支持签约主体为企业时指定，允许指定多个印章类型，英文逗号分隔） ALL -不指定印章类型， COMMON -无业务类型(其他)， CONTRACT -合同专用章， FINANCE -财务章， PERSONNEL -人事专用章， PUBLIC -公章
	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坐标，坐标为印章中心点注：指定XY坐标定位：【请点击】根据关键字辅助定位接口【请点击】
		posY		float	否	body	y坐标，坐标为印章中心点
	width			int32	否	body	签署区的宽度（矩形的左右边距距离，单位为px）注：可搭配height一起使用，如不指定height，则高度根据宽度等比缩放
height			int32	否	body	签署区的高度（矩形的上下边距距离，单位为px）注：必须搭配width一起使用
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	第三方流水号注： 1.该字段属于自定义内容，传入的内容会在后续【签署人签署完成回调通知】以及【查询签署区】【查询签署人】接口中原样返回。可以通过该字段的传值标识自己的业务以及签署方信息。 2.须保证同流程中相同签署人、相同签约主体、相同签署顺序的任务，对应的该字段值唯一举例：N001-15300001111（自己的标识+手机号）
docs					array	是	body	待签署文件信息
	fileId				string	是	body	待签署文件ID 可通过【上传本地文件】获取fileId。
	fileName				string	否	body	文件名称（必须带上文件扩展名，不然会导致后续发起流程校验过不去示例：合同.pdf ）；查看文件名称用途效果示例注意：（1）该字段的文件后缀名称和真实的文件后缀需要一致。比如上传的文件类型是word文件，那该参数需要传“xxx.docx”，不能是“xxx.pdf” （2）文件名称不支持以下9个字符：/ \ : * " < > \| ？以及所有emoji表情
	encryption				int32	否	body	是否加密，0-不加密，1-加密，默认0 查看PDF编辑密码描述注：（1）设置编辑密码的PDF文件需要输入密码才有权限进行盖章操作。（2）encryption填写1时，同时需要向filePassword参数填写编辑密码。（3）支持自动盖章场景。（4）不支持手动盖章场景。
	filePassword				string	否	body	文档编辑密码当encryption值为1时, filePassword值必须填写。当encryption值为0时, filePassword值允许为空。
attachments					array	否	body	附件信息（仅用于查看，不需要签署的文档）
	fileId				string	是	body	附属材料ID 可通过【上传附属材料】获取fileId。
	attachmentName				string	是	body	附属材料名称查看附件名称用途效果示例注：文件名称不支持以下9个字符：/ \ : * " < > \| ？以及所有emoji表情
copiers					array	否	body	抄送人列表注：抄送人指不参与签署，只查看签署文件的人
	copierIdentityAccountType				int32	否	body	参与主体类型 0-个人, 1-企业, 默认个人
	copierAccount				string	否	body	抄送人的登录凭证,手机号或邮箱
	copierAccountId				string	否	body	抄送人的账号ID
	copierIdentityAccount				string	否	body	抄送主体真实信息，个人手机号、邮箱或企业名称
	copierIdentityAccountId				string	否	body	抄送主体账号ID

响应参数

展开全部参数参数名称		类型	必选	参数说明
code		int	是	业务码，0表示成功
message		string	否	业务信息
data		object	否	业务数据
	flowId	string	否	签署流程ID

请求示例

参数示例仅供参考，请根据实际情况传参（演示场景为个人用户和企业用户双方签署）

{
    "flowInfo": {
        "businessScene": "测试免登签署",
        "autoArchive": false,
        "autoInitiate": true,
        "signValidity": "",
        "flowConfigInfo": {
            "identificationConfig": {
                "faceVideoTemplate": "",
                "orgAvailableAuthTypes": [
                    "ORG_BANK_TRANSFER"
                ],
                "personAuthAdvancedEnabled": [
                    "PSN_FACEAUTH_BYURL"
                ],
                "personAvailableAuthTypes": [],
                "willTypes": [
                    "FACE_ZHIMA_XY",
                    "FACE_TECENT_CLOUD_H5"
                ]
            },
            "notifyConfig": {
                "noticeDeveloperUrl": "http://xx.xx.x.x/notify",
                "noticeType": ""
            },
            "signConfig": {
                "batchDropSeal": true,
                "countdown": 0,
                "mobileShieldWay": 1,
                "redirectDelayTime": 0,
                "redirectUrl": "https://www.xxx.cn/",
                "signPlatform": "1"
            }
        }
    },
    "signers": [
        {
            "platformSign": false,
            "signerAccount": {
                "signerAccountId": "094256a9d14a6xxx"
            },
            "signfields": [
                {
                    "fileId": "00f2c7031axxx2f2",
                    "autoExecute": false,
                    "actorIndentityType": 0,
                    "posBean": {
                        "posPage": "1",
                        "posX": 120,
                        "posY": 256
                    },
                    "signDateBeanType": 1,
                    "signDateBean": {
                        "posPage": "1",
                        "posX": 120,
                        "posY": 100,
                        "fontSize": 20
                    }
                }
            ],
            "thirdOrderNo": "123测试"
        },
        {
            "platformSign": false,
            "signerAccount": {
                "signerAccountId": "c7e002xxxxxxx541e7",
                "authorizedAccountId": "0f24d2fca5bxxxx2a6644",
                "orgAccountInfo": {
                    "certNo": "911112200xxxx00001",
                    "certType": "CRED_ORG_USCC",
                    "legalRepCertNo": "1101011xxx82896",
                    "legalRepCertType": "CRED_PSN_CH_IDCARD",
                    "legalRepName": "***"
                }
            },
            "signfields": [
                {
                    "fileId": "00f2c7031a094256a9d14a6d6616xxx",
                    "autoExecute": false,
                    "actorIndentityType": 2,
                    "posBean": {
                        "posPage": "1",
                        "posX": 250,
                        "posY": 256
                    },
                    "signDateBeanType": 1,
                    "signDateBean": {
                        "posPage": "1",
                        "posX": 250,
                        "posY": 100,
                        "fontSize": 20
                    }
                }
            ],
            "thirdOrderNo": "456测试"
        }
    ],
    "docs": [
        {
            "fileId": "00f2c7031a094256a9d14a6d6616xxx",
            "fileName": "test.pdf"
        }
    ],
    "attachments": [
        {
            "fileId": "11f2c7031a094256a9d14a6d6616xxx",
            "attachmentName": "1.png"
        }
    ]
}

响应示例

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

错误码

错误码	报错描述
1435002	参数错误:flowId 流程Id不能为空
1435002	参数错误: 签署主体类型非法
1435002	参数错误: 签署主体证书不存在
1435002	参数错误，授权主体账号不能为空
1435002	参数错误: 用户未授权或授权已过期，不允许静默签署
1435002	参数错误: businessScene不能为空
1435002	参数错误: 签署主体未指定印章且不存在默认印章
1435002	参数错误: 无效的印章
1435002	参数错误: 印章和签署主体不匹配
1435002	参数错误: 文件id不在签署流程中，请先添加文件到流程中，即可添加签署区，fileId：xxx
1435002	参数错误: 签署方账号不能为空!
1435002	参数错误: 签署方信息不能为空
1435002	参数错误: 骑缝签署：必须满足','或'-'分割
1435002	参数错误: 签署人不能为机构类型
1435002	参数错误: 不支持自动签署
1437608	流程创建签署人或签署主体个数%s超过数量限制，最多允许创建%s个。