（完整版）基于文件发起签署

接口描述

开发者可基于已上传的合同文件或模板所填充生成的文件来发起签署流程。

与（精简版）基于文件发起签署 是同一个接口。该完整版文档包含全部的接口参数，而精简版只包含常用和必须的接口参数。

【注意事项】

1. 单个签署流程中对签署文件（docs）要求如下：

单个签署流程中所添加的文件个数不可超过50个。
单个文件大小不可超过50MB。
单个文件内单页大小不可超过20MB（文件内含图片时，需特别关注单页大小）。
单个签署流程中所添加的文件大小总和不可超过500MB。

2. 单个签署流程中一次性添加的签署方（signers）不要超过10个，如果超过10个后续可以用《追加签署区》接口追加，整个流程不能超过50个签署方。

3. 单个签署流程中所添加的签署区（signFields）总和不要超过300个。

4. 单个签署流程中对附属材料（attachments）要求如下：

单个签署流程中所添加的附件个数不可超过50个。
单个附件大小不可超过10MB。

接口地址&请求方法

点击下述蓝色字体{host}可跳转至API请求域名说明文档

接口地址：https://{host}/v3/sign-flow/create-by-file

请求方法：POST

请求头格式

具体请求头参数，请查看公共请求头格式。

请求参数

开发者可通过【签字盖章核心操作演示视频】和【发起签署参数可视化讲解页】来辅助理解签章及参数含义。

展开全部参数参数名称（点击左侧“+”一键展开参数）					参数类型	必选	参数位置	参数说明（请左右滑动查看完整描述）
docs（点击“+”展开详情）					array	否	body	设置待签署文件信息（点击了解直接上传待签署文件）流程中如需一次完成多份文件签署，可传入多个docs数组；当发起流程而相关签署需求无法确定时，允许不传docs（同时签署方参数signers也无需设置、是否自动开启autoStart必须设置为false），发起签署后再【追加签署文件】。
	fileId				string	是	body	待签署文件ID
	fileName				string	否	body	文件名称（需要添加PDF文件后缀名，“xxx.pdf”）【注】文件名称不可含有以下9个特殊字符：/ \ : * " < > \| ？以及所有emoji表情
	neededPwd				boolean	否	body	是否需要密码，默认false
	fileEditPwd				string	否	body	文件编辑密码（点击查看示例-PDF文件编辑密码）
	contractBizTypeId				string	否	body	合同类型ID 补充说明：通过e签宝SaaS官网进行设置和复制ID：登录官网企业空间首页-合同管理-智能台账-合同类型中设置（点击这里了解更多智能台账功能）合同类型ID必须在合同发起方的e签宝官网企业空间下建立
	order				int	否	body	文件在签署页面的展示顺序按序展示时支持传入顺序值：1 - 50（值越小越靠前）
attachments（点击“+”展开详情）					array	否	body	设置附属材料信息（点击了解添加合同附件）【注】附属材料即附件，指无需签名的文件，仅用于查看
	fileId				string	否	body	附属材料文件ID
	fileName				string	否	body	附属材料名称（需要添加文件真实后缀名，例如：“xxx.pdf”）【注】名称不可含有以下9个特殊字符：/ \ : * " < > \| ？以及所有emoji表情
signFlowConfig（点击“+”展开详情）					object	是	body	签署流程配置项
	signFlowTitle				string	是	body	签署流程主题（将展示在签署通知和签署页的任务信息中）【注】主题名称不可含有以下9个特殊字符：/ \ : * " < > \| ？以及所有emoji表情
	signFlowExpireTime				int64	否	body	签署截止时间， unix时间戳（毫秒）格式（点击了解指定签署截止日期）补充说明：默认在签署流程创建后的90天时截止（指定值最大不能超过90天，只能指定90天内的时间戳）。签署中如需延期请调用【延期签署截止时间】接口。
	autoStart				boolean	否	body	自动开启签署流程，默认值 true true - 自动开启（发起签署流程，将直接进入“签署中”状态） false - 非自动开启（发起“草稿”状态的签署流程，需调用【开启签署流程】接口后流程进入“签署中”状态）补充说明：自动开启的流程不允许再追加待签署文件，点击这里了解更多流程状态说明。
	autoFinish				boolean	否	body	所有签署方签署完成后流程自动完结，默认值 false true - 自动完结 false - 非自动完结，需调用【完结签署流程】接口完结补充说明：设置了自动完结的流程中不允许再追加签署区、抄送方，点击这里了解更多流程状态说明。
	identityVerify				boolean	否	body	身份校验配置项（当开发者指定的签署人信息与该签署人在e签宝已有的身份信息不一致时如何处理），默认：true true - 接口报错（提示：传入的指定签署人信息与实名信息不一致相关报错） false - 不报错，正常发起（签署人可以在签署链接中修改账号信息，开发者再通过回调通知接收相关改动信息，详见【签署人更正个人信息回调通知】）补充说明：关于用户侧页面报错账号信息不一致：点击查看解决方案
	notifyUrl				string	否	body	接收相关回调通知的Web地址，详见【签署回调通知接收说明】
	redirectConfig				object	否	body	重定向配置项
		redirectUrl			string	否	body	签署完成后跳转页面（除app和小程序端集成外，地址需符合 https /http 协议地址）【注】贵司的重定向域名需要在e签宝提前放行，否则会报错：“您即将访问的页面可能有安全风险”。（点击跳转重定向域名配置说明）签署完成后会在贵司重定向地址上拼接签署状态等字段。（点击跳转签署页重定向跳转说明）
		redirectDelayTime			int32	否	body	操作完成重定向跳转延迟时间，单位秒（可选值0、3，默认值为 3）传0时，签署完成直接跳转重定向地址；传3时，展示签署完成结果页，倒计时3秒后，自动跳转重定向地址。【注】当redirectUrl不传的情况下，该字段无需传入，签署完成不跳转
	signConfig				object	否	body	签署配置项
		availableSignClientTypes			string	否	body	签署终端类型，默认值：1,2（英文逗号分隔）（点击了解网页端OR支付宝端签署） 1 - 网页（自适配H5/PC样式），2 - 支付宝【注】如果是开发者自己的app或者支付宝小程序等端内嵌e签宝H5/PC，需要传：1（网页端）
		showBatchDropSealButton			boolean	否	body	签署页面是否显示“同时盖在所有签署区”按钮，默认值 true true - 显示（显示按钮并默认开启） false - 不显示（不显示按钮，即：不能同时盖在所有签署区）
		signMode			string	否	body	签署模式，默认：NORMAL NORMAL - 中国大陆签 GLOBAL - 海外签【注】海外签需要购买对应套餐才可以使用
dedicatedCloudId			string	否	body	专属云项目ID 补充说明：专属云：文件需要存储在开发者本地系统，购买了专属云服务时使用；专属云项目ID需要先在【获取文件上传地址】接口传入，这里传同一个项目ID才可用。
noticeConfig				object	否	body	流程整体通知配置项
		noticeTypes			string	否	body	通知类型，通知发起方、签署方、抄送方，默认不通知（值为""空字符串），允许多种通知方式，请使用英文逗号分隔）（点解了解指定e签宝短信/邮件通知签署）传空 - 不通知（默认值） 1 - 短信通知（如果套餐内带“分项”字样，请确保开通【电子签名流量费（分项）认证】中的子项：【短信服务】，否则短信通知收不到） 2 - 邮件通知 3 - 钉钉工作通知（需使用e签宝钉签产品） 5 - 微信通知（用户需关注“e签宝电子签名”微信公众号且使用过e签宝微信小程序）【注】 1 和 2：个人账号中需要绑定短信/邮件才有对应的通知方式； 3 和 5：仅限e签宝正式环境调用才会有。
	examineNotice			boolean	否	body	通知给企业印章用印审批人员的通知类型，按照账号中的手机号或邮箱的填写情况进行通知。 true - 发送消息（短信+邮件+e签宝官网站内信）（如果套餐内带“分项”字样，请确保开通【电子签名流量费（分项）认证】中的子项：【短信服务】，否则短信通知收不到） false - 不发送消息【注】不传值默认取noticeTypes配置的通知方式
authConfig				object	否	body	流程整体认证配置项
	willingnessAuthModes			list	否	body	签署意愿认证方式，可选值如下： CODE_SMS - 短信验证码 PSN_FACE_ALIPAY - 支付宝刷脸 PSN_FACE_ESIGN - 快捷刷脸 PSN_FACE_WECHAT - 微信小程序刷脸（仅限微信小程序中使用） SIGN_PWD - 签署密码以下方式如需使用，请联系交付顾问开通： PSN_FACE_TECENT - 腾讯云刷脸 PSN_AUDIO_VIDEO_ALIPAY - 支付宝智能视频认证 PSN_AUDIO_VIDEO_WECHAT - 微信智能视频认证【注】使用iframe内嵌集成不支持对接刷脸方式建议意愿认证方式和实名方式保持一致，如实名用的刷脸认证，这里意愿也用刷脸，如果更换短信验证码方式可能会导致认证无法通过。
	psnAvailableAuthModes			list	否	body	个人实名认证方式，可选值： PSN_MOBILE3 - 个人运营商三要素认证 PSN_FACE - 刷脸认证 PSN_BANKCARD4 - 个人银行卡四要素认证【注】使用iframe内嵌集成不支持对接刷脸方式
	orgAvailableAuthModes			list	否	body	机构实名认证方式，可选值： ORG_BANK_TRANSFER - 对公打款认证 ORG_ALIPAY_CREDIT - 法人快捷认证（必须操作人为法定代表人本人场景才会显示，需要法人支付宝刷脸授权完成认证） ORG_LEGALREP_AUTHORIZATION - 法人授权认证（必须操作人非法定代表人本人场景才会显示，会通知法人在线签署授权书，授权给操作人） ORG_LEGALREP - 法定代表人认证（必须操作人为法定代表人本人场景才会显示，法人任选一种个人认证方式完成认证）
	audioVideoTemplateId			string	否	body	智能视频认证模板ID，请联系交付顾问提供
contractConfig				object	否	body	合同相关配置项
	contractSecrecy			int	否	body	合同保密配置，默认：1 - 合同不保密 1 - 合同不保密 2 - 合同全部保密（合同保密功能同e签宝SaaS官网一致，点击了解）
	allowToRescind			boolean	否	body	该签署流程是否允许发起解约，默认true true - 允许 false - 不允许
contractGroupIds				list	否	body	企业合同归档文件夹ID（点击这里了解更多合同管理功能）补充说明：通过e签宝SaaS官网进行设置和复制文件夹ID：登录官网企业空间首页-合同管理-企业合同-已归档合同中新建分类-详情中复制分类ID 归档文件夹ID必须在合同发起方的e签宝官网企业空间下建立如果合同需要归档分类到多个文件夹中，该字段中可以传入多个文件夹ID，最多可传入10个
docsViewLimited				boolean	否	body	是否开启签署方的文件查看范围限制，默认不开启 true - 开启（开启后可在签署方下设置可查看的文件列表，通过docsViewType和viewableFileIds字段控制） false - 不开启
signFlowInitiator（点击“+”展开详情）					object	否	body	签署流程的发起方（指在平台中发起合同签约的一方，合同的归属方，有权限查看签署的文件，签署通知中展示：“XXX 通知您签署... ”中的XXX即为发起方名字。）（点击了解指定合同发起方）不传则默认为应用ID所属的企业来发起签署流程；发起方可以为个人或者机构，但不可同时传值（orgInitiator与psnInitiator 二选一传入）；（自2024年9月12日起，仅e签宝高级版和生态伙伴版本支持指定非应用ID所属企业作为机构发起方，仅e签宝生态伙伴版本支持指定个人发起方）
	orgInitiator				object	否	body	机构发起方信息（自2024年9月12日起，仅e签宝高级版和生态伙伴版本支持指定非应用ID所属企业作为机构发起方）当指定发起方为非应用ID所属企业时：（1）e签宝生态版本需先经过【用户授权】（代企业和经办人用户发起合同签署权限）；（2）e签宝宝高级版需经过e签宝官网的【关联企业】开通。
		orgId			string	否	body	机构账号ID 【注】用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询
transactor			object	否	body	机构发起方的经办人（机构发起签署场景，经办人账号ID为必传项）
		psnId		string	否	body	经办人账号ID 【注】用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识（手机号或邮箱）/个人用户的证件号进行查询
psnInitiator				object	否	body	个人发起方信息（自2024年9月12日起，仅e签宝生态伙伴版本支持指定个人发起方） e签宝生态版本需先经过【用户授权】（代个人用户发起合同签署权限）；
	psnId			string	否	body	个人账号ID 【注】用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识（手机号或邮箱）/个人用户的证件号进行查询
signers（点击“+”展开详情）					array	否	body	签署方信息（指参与签署的个人或者机构）（点击了解如何指定双方签署）单个签署方数组中，机构签署方、个人签署方二选一传入（orgSignerInfo与psnSignerInfo二选一即可）；多方签署场景，可传多个签署方数组；单个签署流程中，签署方最多不能超过10个。【注】该接口如果未添加签署方信息，则需要后续在流程中添加，调用【追加签署区】接口添加。
	signConfig				object	否	body	签署人配置项
		signOrder			int32	否	body	设置签署方的签署顺序按序签时支持传入顺序值 1 - 255（值小的先签署）同时签时，允许值重复
		forcedReadingTime			int32	否	body	设置签署页面强制阅读倒计时时间，默认值为 0（单位：秒，最大值999）
		agreeSkipWillingness			boolean	否	body	签署人是否需要免意愿快捷签署，默认false true - 需要 false - 不需要（点击了解免意愿快捷签署）补充说明：免意愿快捷签署需要提前联系与您对接的技术/业务人员确认场景，场景审批通过后开通才可使用（例如：处方单、物流承运协议等需要个人频繁签署的低风险场景，企业签署不支持，仅限个人签署）；免意愿快捷签署是指用户在e签宝页面签署过程中勾选同意《快捷签署服务协议》后，当前用户在约定时间内（默认7天）再次在当前开发者appId、当前终端设备下签署即可免除意愿认证，直接签署成功。
		signTaskType			int32	否	body	签署任务类型，默认值为 0 0 - 会签（所有指定的签署方均必须签署） 1 - 或签（多个签署方中，任意一方签署即可完成签署流程）（点击了解会签与或签）或签场景补充说明：指定的签署方数量必须>=2，其中任意一方签署即可所有签署方和签署区的配置以及签署的文件需要一致或签不允许自动签署不允许同一个经办人代不同的主体或签
		signTipsTitle			string	否	body	签署前提示弹框自定义签署声明--文案标题（最多20字）补充说明：当前签署方在签署页面进入后，展示该弹框提示，点击“我已知悉上述内容”按钮后关闭弹框，进入签署合同页。必须与下方signTipsContent字段配套使用。
		signTipsContent			string	否	body	签署前提示弹框自定义签署声明--文案内容（最多500字）补充说明：当前签署方在签署页面进入后，展示该弹框提示，点击“我已知悉上述内容”按钮后关闭弹框，进入签署合同页。必须与上方signTipsTitle字段配套使用。
uploadFiles			array	否	body	允许签署方在签署时上传的附件列表配置补充说明：需要签署方在签署页自主上传附属材料时，对应的附属文件要求在此配置不需要签署方自主上传附件时，此项无需传入
		uploadDescription		string	否	body	附件的标题描述，会显示在签署详情页内比如：身份证信息面、身份证国徽页
		required		boolean	否	body	此附件是否必传，默认true true - 必传 false - 非必传【注】如设置了必传，但是签署方在页面没有上传是无法提交签署的
docsViewType			int32	否	body	签署方可见文件类型，默认：1 1：允许查看流程内所有文件 2：仅允许查看自身签署的文件和指定文件（通过viewableFileIds指定文件id列表）【注】：流程配置里的docsViewLimited需要传：true，这里指定2才生效。
viewableFileIds			list	否	body	指定签署方允许查看的文件id列表（仅在docsViewType为2的情况下生效）
authConfig				object	否	body	签署方维度认证配置项
		willingnessAuthModes			list	否	body	签署意愿认证方式，可选值如下： CODE_SMS - 短信验证码 PSN_FACE_ALIPAY - 支付宝刷脸 PSN_FACE_ESIGN - 快捷刷脸 PSN_FACE_WECHAT - 微信小程序刷脸（仅限微信小程序中使用） SIGN_PWD - 签署密码以下方式如需使用，请联系交付顾问开通： PSN_FACE_TECENT - 腾讯云刷脸 PSN_AUDIO_VIDEO_ALIPAY - 支付宝智能视频认证 PSN_AUDIO_VIDEO_WECHAT - 微信智能视频认证【注】使用iframe内嵌集成不支持对接刷脸方式建议意愿认证方式和实名方式保持一致，如实名用的刷脸认证，这里意愿也用刷脸，如果更换短信验证码方式可能会导致认证无法通过。
	psnAvailableAuthModes			list	否	body	个人实名认证方式，可选值： PSN_MOBILE3 - 个人运营商三要素认证 PSN_FACE - 刷脸认证 PSN_BANKCARD4 - 个人银行卡四要素认证【注】使用iframe内嵌集成不支持对接刷脸方式
	orgAvailableAuthModes			list	否	body	机构实名认证方式，可选值： ORG_BANK_TRANSFER - 对公打款认证 ORG_ALIPAY_CREDIT - 法人快捷认证（必须操作人为法定代表人本人场景才会显示，需要法人支付宝刷脸授权完成认证） ORG_LEGALREP_AUTHORIZATION - 法人授权认证（必须操作人非法定代表人本人场景才会显示，会通知法人在线签署授权书，授权给操作人） ORG_LEGALREP - 法定代表人认证（必须操作人为法定代表人本人场景才会显示，法人任选一种个人认证方式完成认证）
	globalWillingness			boolean	否	body	是否需要意愿认证，默认：true true - 需要 false - 不需要（仅限海外签时可配置，signMode=GLOBAL）
	globalAuthModes			string	否	body	海外签身份验证方式，默认：MAINLAND_REAL_NAME MAINLAND_REAL_NAME - 中国实名（中国大陆签原有方式） NO_NEED - 无需验证（仅限海外签时可配置，signMode=GLOBAL） ACCESS_CODE - 访问口令（仅限海外签时可配置，signMode=GLOBAL；且配置该方式时，globalAccessCode必须传值）
	globalAccessCode			string	否	body	海外签访问口令（仅限海外签时可配置，signMode=GLOBAL）【注】支持6-45位，只支持字母和数字
noticeConfig				object	否	body	设置签署方的通知方式
	noticeTypes			string	否	body	通知类型，默认不通知（值为""空字符串），允许多种通知方式，请使用英文逗号分隔（点解了解指定e签宝短信/邮件通知签署）传空 - 不通知（默认值） 1 - 短信通知（如果套餐内带“分项”字样，请确保开通【电子签名流量费（分项）认证】中的子项：【短信服务】，否则短信通知收不到） 2 - 邮件通知 3 - 钉钉工作通知（需使用e签宝钉签产品） 5 - 微信通知（用户需关注“e签宝电子签名”微信公众号且使用过e签宝微信小程序）补充说明： 1 和 2：个人账号中需要绑定短信/邮件才有对应的通知方式； 3 和 5：仅限e签宝正式环境调用才会有；该通知是签署方维度的，只控制签署人的签署提醒短信，不控制流程的撤销、完成、抄送等短信通知。（流程维度在signFlowConfig里的noticeTypes控制）
signerType				int32	是	body	签署方类型，0 - 个人，1 - 企业/机构，2 - 法定代表人，3 - 经办人若指定签署方为个人，则psnSignerInfo为必传项；若指定签署方为机构或法定代表人手动签署（autoSign参数为false）时，则orgSignerInfo为必传项；若指定签署方为经办人，在同级数组内必须还有机构类型存在，且orgSignerInfo为必传项，即：指定3 - 经办人签的前提是必须同时存在1 - 企业/机构（且autoSign参数为false），且经办人签属于企业合同，不在个人名下。
orgSignerInfo				object	否	body	企业/机构签署方信息当签署主体为企业/机构用户、autoSign参数为false手动签章时，请必须传入此对象（orgName与orgId二选一传值即可）当企业/机构用户选择静默签署，autoSign参数为true自动落章时，建议不传此对象，e签宝后台会取默认值
	orgId			string	否	body	企业/机构账号ID 【注】用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询
	orgName			string	否	body	企业/机构名称（账号标识）
	orgInfo			object	否	body	企业/机构签署方信息（将展示在机构认证页面）
		legalRepName		string	否	body	法定代表人姓名
legalRepIDCardNum		string	否	body	法定代表人证件号
legalRepIDCardType		string	否	body	法定代表人证件类型，可选值如下： CRED_PSN_CH_IDCARD - 中国大陆居民身份证（默认值） CRED_PSN_CH_HONGKONG - 香港来往大陆通行证（回乡证） CRED_PSN_CH_MACAO - 澳门来往大陆通行证（回乡证） CRED_PSN_CH_TWCARD - 台湾来往大陆通行证（台胞证） CRED_PSN_PASSPORT - 护照
orgIDCardNum		string	否	body	企业/机构证件号
orgIDCardType		string	否	body	企业/机构证件类型，可选值如下： CRED_ORG_USCC - 统一社会信用代码 CRED_ORG_REGCODE - 工商注册号
transactorInfo			object	否	body	企业/机构经办人信息企业/机构手动签署（autoSign为false），经办人信息必传；企业/机构自动落章（autoSign为true），请不要传该参数。
		psnAccount		string	否	body	经办人账号标识，手机号或邮箱【注】指定orgName时，该参数为必传项，为了保证签署人准确，必须配合psnName（经办人姓名）传入
		psnId		string	否	body	经办人账号ID（指定orgId时，该参数为必传项）【注】用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识（手机号或邮箱）/个人用户的证件号进行查询
		psnInfo		object	否	body	经办人身份信息
		psnName	string	是	body	经办人姓名【注】传psnAccount（经办人账号标识）时，该参数为必传项
	psnIDCardNum	string	否	body	经办人证件号
	psnIDCardType	string	否	body	经办人证件类型，可选值如下： CRED_PSN_CH_IDCARD - 中国大陆居民身份证（默认值） CRED_PSN_CH_HONGKONG - 香港来往大陆通行证（回乡证） CRED_PSN_CH_MACAO - 澳门来往大陆通行证（回乡证） CRED_PSN_CH_TWCARD - 台湾来往大陆通行证（台胞证） CRED_PSN_PASSPORT - 护照【注】CRED_PSN_CH_IDCARD 类型同时兼容港澳台居住证（81、82、83开头18位证件号）、外国人永久居住证（9开头18位证件号）
psnSignerInfo				object	否	body	个人签署方信息当签署主体为个人时请传此对象，psnAccount与psnId二选一传值即可
	psnAccount			string	否	body	个人账号标识（手机号或邮箱）用于登录e签宝官网的凭证【注】为了保证签署人准确，必须配合psnName（个人姓名）传入
	psnId			string	否	body	个人账号ID 【注】用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识（手机号或邮箱）/个人用户的证件号进行查询
	psnInfo			object	否	body	个人签署方身份信息补充说明：已实名用户，若传入的psnInfo与在e签宝绑定的psnAccount一致，则无需重复实名，签署页直接进行签署意愿认证；已实名用户，若传入的psnInfo与在e签宝绑定的psnAccount不一致，则接口将会报错，建议核实用户身份信息后重新发起流程；未实名用户，签署页将根据传入的身份信息进行用户实名认证。
	psnName		string	是	body	个人姓名【注】传psnAccount（个人账号标识）时，该参数为必传项
	psnIDCardNum		string	否	body	个人证件号
	psnIDCardType		string	否	body	个人证件类型，可选值如下： CRED_PSN_CH_IDCARD - 中国大陆居民身份证（默认值） CRED_PSN_CH_HONGKONG - 香港来往大陆通行证（回乡证） CRED_PSN_CH_MACAO - 澳门来往大陆通行证（回乡证） CRED_PSN_CH_TWCARD - 台湾来往大陆通行证（台胞证） CRED_PSN_PASSPORT - 护照【注】CRED_PSN_CH_IDCARD 类型同时兼容港澳台居住证（81、82、83开头18位证件号）、外国人永久居住证（9开头18位证件号）
	psnMobile		string	否	body	个人手机号（运营商实名登记手机号或银行卡预留手机号，仅用于认证）
	bankCardNum		string	否	body	个人银行卡号
signFields				array	是	body	签署区信息（设置签署方盖章/签名/文字输入的区域）【注】指定了签署方signers的情况下，签署区必传（单个签署方若对应多个签署区，可传多个数组，整个流程中，签署区不能超过300个）
	fileId			string	是	body	签署区所在待签署文件ID 【注】这里的fileId需先添加在docs数组中，否则会报错“参数错误: 文件id不在签署流程中”。
	customBizNum			string	否	body	开发者自定义业务编号【注】该参数会在【签署方-签署结果通知】中原样返回，用于标识开发者自身业务
	signFieldType			int32	否	body	签署区类型，默认值为 0 0 - 签章区（添加印章、签名等） 1 - 备注区（添加备注文字信息等）（点击了解备注签署） 2 - 独立签署日期（添加单独的签署日期）
	mustSign			boolean	否	body	该签署区是否必须签署，默认值为 true（必须签） true - 是 false - 否场景对接说明详见：【选签（非必须签）】（该参数设置：false时）补充说明：常规场景都是必须签署，不需要额外指定该参数为 false，如果需要选签（非必须签）功能，则不允许设置自动落章。
	normalSignFieldConfig			object	否	body	签章区配置项（指定signFieldType为 0 - 签章区时，该参数为必传项）
		freeMode		boolean	否	body	是否自由签章，默认值 false （点击了解指定位置签章与自由签章） true - 是，false - 否补充说明：自由签章指不限制印章、签署位置、签章样式（单页、骑缝）、和签章个数。自由签章模式下，无需传normalSignFieldConfig对象下的其他参数。
		autoSign		boolean	否	body	是否后台自动落章，默认值 false true - 后台自动落章（无感知），false - 签署页手动签章补充说明：当签署方为个人时，不支持自动签章。当签署方为机构（且非应用Id所属企业），静默签署自动落章需先经过印章授权，点击查看印章授权规则。当签署方为应用Id所属主体企业自身静默签署时，支持后台自动落章。（自2024年9月12日起，机构用户自动落章（跨企业印章授权自动签署）功能需要购买e签宝高级版或生态伙伴版本方可支持）
		movableSignField		boolean	否	body	页面是否可移动签章区，默认值 false true - 可移动，false - 不可移动
assignedSealId		string	否	body	指定印章ID（印章ID是e签宝SaaS官网的印章编号，点击查看获取方式）【注】平台方企业自动落章场景，如不指定印章ID，则取平台默认印章
availableSealIds		list	否	body	手动签章时页面可选的印章列表（印章ID是e签宝SaaS官网的印章编号）
orgSealBizTypes		string	否	body	页面可选机构印章类型，默认值ALL（多项请使用英文逗号分隔） ALL - 显示所有类型的印章 PUBLIC - 机构主体公章 CONTRACT - 合同专用章 FINANCE - 财务专用章 PERSONNEL -人事专用章 COMMON -其他类印章（无具体业务类型的章）
psnSealStyles		string	否	body	页面可选个人印章样式，默认值0和1（英文逗号分隔）（点击了解个人手写签名与姓名印章） 0 - 手写签名 1 - 姓名印章 2 - 手写签名AI校验
signFieldSize		int	否	body	签章区尺寸（正方形的边长，单位为px）补充说明：指定的签署区的宽度，高度等比缩放；不指定默认以印章原始大小加盖不能与signFieldWidth、signFieldHeight同时传入
signFieldWidth		int	否	body	签署区宽度（矩形的左右边距距离，单位为px）补充说明：印章需要自定义规格时传入该参数（根据指定的签署区宽高适配）；不指定默认以印章原始大小加盖与signFieldHeight搭配使用，但不能与signFieldSize同时传入
signFieldHeight		int	否	body	签署区高度（矩形的上下边距距离，单位为px）补充说明：印章需要自定义规格时传入该参数（根据指定的签署区宽高适配）；不指定默认以印章原始大小加盖与signFieldWidth搭配使用，但不能与signFieldSize同时传入
signFieldStyle		int32	否	body	签章区样式 1 - 单页签章，2 - 骑缝签章（点击了解骑缝盖章）
signFieldPosition		object	否	body	签章区位置信息（点击了解指定位置签章与自由签章）
		acrossPageMode	string	否	body	骑缝章模式选择（点击了解骑缝盖章） ALL - 全部页盖骑缝章，AssignedPages - 指定页码盖骑缝章补充说明：当signFieldStyle为1即单页签章时，该参数无需设置当signFieldStyle为2即骑缝签章时，可以指定该参数，默认值ALL
		positionPage	string	否	body	签章区所在页码补充说明：（1）当signFieldStyle为1即单页签章时，只能传单个页码（2）当signFieldStyle为2即骑缝签章时，且acrossPageMode为AssignedPages即指定页码范围时，连续页码可使用'-'指定页码范围，多个页码范围用逗号分隔，例如：1-3,6-10
		positionX	float	否	body	签章区所在X坐标（当signFieldStyle为2即骑缝签章时，该参数不生效，可不传值）【注】可选择如下方式可以确定坐标：（1）开放平台拖章定位工具：【请点击】（2）根据关键字辅助定位接口【请点击】
		positionY	float	否	body	签章区所在Y坐标
remarkSignFieldConfig			object	否	body	备注区配置项（指定signFieldType为 1 - 备注区时，该参数为必传项）（点击了解备注签署）【注】备注区只支持个人签署方
		freeMode		boolean	否	body	自由备注模式，默认值 false true - 是，false - 否。补充说明：自由备注指由用户选择是否备注，且不限备注位置和备注区个数。
		inputType		int32	否	body	文字输入方式，默认值：1 1 - 手写抄录方式，2 - 键盘输入方式【注】inputType=2（键盘输入方式）时，aiCheck和remarkContent参数值不生效
		aiCheck		int32	否	body	是否开启手写抄录AI校验，默认值：0 0 - 不开启，1 - 开启 AI 校验，2 - 强制 AI 校验
		remarkContent		string	否	body	预设待抄录信息（最多支持100个汉字，含标点符号，内容中输入\n可以换行）【注】inputType=1时手写抄录方式此参数必须传值
		movableSignField		boolean	否	body	备注区是否可以移动，默认值 false true - 可移动，false - 位置固定
	remarkFontSize		int32	否	body	备注文字字号，默认值14px
	signFieldHeight		float	否	body	备注区高度（矩形的上下距离，单位为px）
	signFieldWidth		float	否	body	备注区宽度（矩形的左右距离，单位为px）
	signFieldPosition		object	否	body	备注区位置
	positionPage	string	否	body	备注区所在页码，只能传单个页码。
	positionX	float	否	body	备注区所在X坐标
	positionY	float	否	body	备注区所在Y坐标
signDateConfig			object	否	body	签署区/备注区的签署日期配置项（点击了解添加签署日期）补充说明：该日期是跟签署区/备注区关联的，即一个签署区/备注区需要一个签署日期匹配，且必须和签署区/备注区在同一页码当signFieldType（签署区类型）= 0（签章区）时，指定该参数
	dateFormat		string	否	body	日期格式 yyyy年MM月dd日（默认值） yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	fontSize		int32	否	body	日期字体大小，默认值 12px
	showSignDate		int32	否	body	是否显示签署日期，默认值 0 0 - 不显示，1 - 固定位置显示，2 - 不固定位置补充说明：传1时，可以设置签署日期位置的X、Y坐标（如不传入位置坐标，日期默认显示在签署区下方，但不传位置用户手动签署时可移动日期位置，传了位置则不可移动）传2时，由用户在签署页面中选择是否开启显示签署日期（默认不开启），开启后日期位置可在页面移动调整。日期格式、字体大小参数都不生效，需要用户在页面选择。
	signDatePositionX		float	否	body	签署日期所在位置X坐标，当showSignDate为 1- 固定位置显示时生效。
	signDatePositionY		float	否	body	签署日期所在位置Y坐标，当showSignDate为 1- 固定位置显示时生效。
dateSignFieldConfig			object	否	body	独立签署日期配置项补充说明：该日期是跟签署区/备注区独立的，只要保证一个用户下存在至少一个签署区/备注区即可，可以配置多个日期位置且支持和签署区/备注区不在同一页码当signFieldType（签署区类型）= 2（独立签署日期）时，指定该参数
	autoSign		boolean	否	body	是否是后台自动落章关联的独立签署日期，默认值 false true - 后台自动落章关联的独立签署日期（平台静默签署） false - 签署页手动签章关联的独立签署日期【注】当关联的普通签署区包含自动签，即签署区数组中存在normalSignFieldConfig中的autoSign=true时，该字段才允许传true
	dateFormat		string	否	body	日期格式 yyyy年MM月dd日（默认值） yyyy-MM-dd yyyy/MM/dd yyyy.MM.dd yyyy年M月d日 yyyy年M月 yyyy/M/d yy-MM-dd
	fontSize		int	否	body	日期字体大小，默认值12px（可传入5-42）
	signDatePositionPage		int	否	body	指定签署日期位置页码【注】允许与签署区位置positionPage的值不一样，即允许跨页添加签署日期
	signDatePositionX		float	否	body	签署日期所在位置X坐标
	signDatePositionY		float	否	body	签署日期所在位置Y坐标
copiers（点击“+”展开详情）					array	否	body	抄送方信息（指不参与签署的机构或者个人，流程结束后将收到通知，允许查看签署文件）（点击了解添加合同抄送方）如需抄送多个企业或个人，允许传入多个抄送方数组；抄送机构的情况：copierOrgInfo与copierPsnInfo均需传值；抄送个人的情况：仅需传copierPsnInfo；
	copierOrgInfo				object	否	body	机构抄送方信息（orgName与orgId，二选一传值）
		orgName			string	否	body	机构名称
orgId			string	否	body	机构账号ID
copierPsnInfo				object	否	body	个人抄送方信息（psnAccount与psnId，二选一传值）
		psnAccount			string	否	body	个人账号标识（手机号/邮箱号）
	psnId			string	否	body	个人账号ID

响应参数

展开全部参数参数名称		参数类型	必选	参数说明
code		int32	是	业务码，0表示成功，非0表示异常。
message		string	否	业务信息请根据 code 来判断错误情况，不应该依赖 message匹配，因为 message 可能会调整。
data（点击“+”展开详情）		object	否	业务数据
	signFlowId	string	否	签署流程ID（建议开发者保存此流程ID）

请求示例

此场景案例为个人用户和企业用户双方签署案例

更多参数案例请参考【常见场景对接说明】中“发起签署”和“签署可选功能”模块

{
    "docs": [
        {
            "fileId": "55607b*******ed565",
            "fileName": "xx企业劳动合同.pdf"
        }
    ],
    "attachments": [
        {
            "fileId": "55607b******5f92ed565",
            "fileName": "入职材料.pdf"
        }
    ],
    "signFlowConfig": {
        "signFlowTitle": "企业员工劳动合同签署",
        "signFlowExpireTime": 1734330195000,
        "autoStart": true,
        "autoFinish": false,
        "identityVerify": true,
        "signConfig": {
            "availableSignClientTypes": "1",
            "showBatchDropSealButton": true
        },
        "notifyUrl": "http://xx.xx.86.172:8081/asyn/notify",
        "redirectConfig": {
            "redirectDelayTime": "3",
            "redirectUrl": "http://www.xx.cn/"
        },
        "authConfig": {
            "psnAvailableAuthModes": [
                "PSN_FACE"
            ],
            "willingnessAuthModes": [
                "PSN_FACE_TECENT",
                "PSN_FACE_ALIPAY"
            ],
            "orgAvailableAuthModes": [
                "ORG_BANK_TRANSFER",
                "ORG_LEGALREP"
            ]
        }
    },
    "signFlowInitiator": {
        "orgInitiator": {
            "orgId": "842ec8ce******fc91662f",
            "transactor": {
                "psnId": "7ffca******f0ef0a8f6"
            }
        }
    },
    "signers": [
        {
            "signConfig": {
                "forcedReadingTime": "10",
                "signOrder": 1
            },
            "noticeConfig": {
                "noticeTypes": "1"
            },
            "signerType": 0,
            "psnSignerInfo": {
                "psnAccount": "153****650",
                "psnInfo": {
                    "psnName": "张三",
                    "psnIDCardNum": "231******29",
                    "psnIDCardType": "CRED_PSN_CH_IDCARD"
                }
            },
            "signFields": [
                {
                    "fileId": "5560*******92ed565",
                    "customBizNum": "自定义编码0001",
                    "signFieldType": 0,
                    "normalSignFieldConfig": {
                        "autoSign": false,
                        "freeMode": false,
                        "movableSignField": false,
                        "psnSealStyles": "0,1",
                        "signFieldSize": "96",
                        "signFieldStyle": 1,
                        "signFieldPosition": {
                            "positionPage": "1",
                            "positionX": 100,
                            "positionY": 200
                        }
                    },
                    "signDateConfig": {
                        "dateFormat": "yyyy-MM-dd",
                        "showSignDate": 1,
                        "signDatePositionX": 100,
                        "signDatePositionY": 100
                    }
                }
            ]
        },
        {
            "signConfig": {
                "forcedReadingTime": "10",
                "signOrder": 2
            },
            "noticeConfig": {
                "noticeTypes": "1,2"
            },
            "signerType": 1,
            "orgSignerInfo": {
                "orgName": "XXXX企业名字",
                "orgInfo": {
                    "orgIDCardNum": "911*******3",
                    "orgIDCardType": "CRED_ORG_USCC"
                },
                "transactorInfo": {
                    "psnAccount": "139****10",
                    "psnInfo": {
                        "psnName": "李四",
                        "psnIDCardNum": "3311********9",
                        "psnIDCardType": "CRED_PSN_CH_IDCARD"
                    }
                }
            },
            "signFields": [
                {
                    "customBizNum": "自定义编码001",
                    "fileId": "55607b*******ed565",
                    "normalSignFieldConfig": {
                        "autoSign": false,
                        "freeMode": false,
                        "movableSignField": false,
                        "signFieldSize": "159",
                        "signFieldStyle": 1,
                        "signFieldPosition": {
                            "positionPage": "1",
                            "positionX": 300,
                            "positionY": 200
                        }
                    },
                    "signDateConfig": {
                        "dateFormat": "yyyy-MM-dd",
                        "showSignDate": 1,
                        "signDatePositionX": 300,
                        "signDatePositionY": 100
                    }
                }
            ]
        }
    ],
    "copiers": [
        {
            "copierOrgInfo": {
                "orgName": "XX抄送企业名称"
            },
            "copierPsnInfo": {
                "psnAccount": "131*****61"
            }
        }
    ]
}

响应示例

{
    "code":0,
    "message":"成功",
    "data":{
        "signFlowId":"165467****000"
    }
}

错误码

点击查看错误码

附录

发起签署的参数较多，不同的场景容易弄混，所以结合四种签署场景，整理了关键参数signers（签署方信息）中的传参规则。

signers中参数设置规则如下（signers本身是数组，多场景可以传多个）：

参数字段\签署场景	appId对应的自身机构自动落章	机构用户自动落章	机构用户手动签署	个人用户手动签署
signerType	传值：1	传值：1	传值：1	传值：0
orgSignerInfo	不传	不传	（1）传入机构用户的账号orgId或者orgName （2）传入代机构签署的经办人信息transactorInfo （1）和（2）均须	不传
psnSignerInfo	不传	不传	不传	个人签署账号psnAccount或者psnId
autoSign	true	true	false	false
assignedSealId	（1）不传此字段取默认印章（2）传入appId对应的自身机构账号的印章ID （1）或者（2）	传入机构用户授权给appId对应的自身机构的印章ID （跨企业印章授权与自动签署流程）	不传	不传

重要提示：自2024年9月12日起，机构用户自动落章（跨企业印章授权自动签署）功能需要购买e签宝高级版或生态伙伴版本方可支持！