追加签署区

接口描述

调用此接口可以向已创建的签署流程中追加签署方、签署区。

注意事项：

在追加一个签署区时，请确保流程在开启之前已添加了该签署区所在的待签署文件，参考【追加待签文件】；
流程在“草稿”和“签署中”状态时，允许向流程中再追加签署区；
【基于文件发起签署】时设置了自动完结（autoFinish为 true）的流程不支持再添加签署区。

接口地址&请求方法

接口地址：https://{host}/v3/sign-flow/{signFlowId}/signers/sign-fields

请求方法：POST

请求头格式

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

请求参数

展开全部参数参数名称					参数类型	必选	参数位置	参数说明
signFlowId					string	是	path	签署流程ID
identityVerify					boolean	否	body	身份校验配置项（当开发者指定的签署人信息与该签署人在e签宝已有的身份信息不一致时如何处理），默认：true true - 接口报错（提示：传入的指定签署人信息与实名信息不一致相关报错） false - 不报错，正常发起（签署人可以在签署链接中修改账号信息，开发者再通过回调通知接收相关改动信息，详见【签署人更正个人信息回调通知】）。
signers（点击“+”展开详情）					array	是	body	添加签署方信息（一个流程中，签署方不能超过300个）
	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	企业/机构签署方信息【注】orgId 与 orgName 二选一传入即可
	orgId			string	否	body	企业/机构账号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	企业/机构签署经办人信息（当签署方为企业/机构时，经办人必传）【注】psnId 与 psnAccount 二选一传入即可
		psnAccount		string	否	body	经办人账号标识，手机号或邮箱【注】指定orgName时，该参数为必传项，为了保证签署人准确，必须配合psnName（经办人姓名）传入
		psnId		string	否	body	经办人账号ID
		psnInfo		object	否	body	经办人身份信息
		psnName	string	是	body	经办人姓名【注】传psnAccount（经办人账号标识）时，该参数为必传项
	bankCardNum	string	否	body	经办人银行卡号
	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 - 护照
psnSignerInfo（点击“+”展开详情）				object	否	body	个人签署方信息【注】psnId 与 psnAccount 二选一传入即可
	psnAccount			string	否	body	个人账号标识（手机号或邮箱）【注】为了保证签署人准确，必须配合psnName（个人姓名）传入
	psnId			string	否	body	个人账号ID
	psnInfo（点击“+”展开详情）			object	否	body	签署方个人身份信息
	psnName		string	是	body	个人姓名【注】传psnAccount（个人账号标识）时，该参数为必传项
	bankCardNum		string	否	body	个人银行卡号
	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 - 护照
signFields（点击“+”展开详情）				array	是	body	签署区信息
	fileId			string	是	body	签署区所在文件ID
	customBizNum			string	否	body	自定义业务编号
	signFieldType			int32	否	body	签署区类型 0 - 签章区（添加印章、签名等） 1 - 备注区（添加备注文字信息等） 2 - 独立签署日期（添加单独的签署日期）
	mustSign			boolean	否	body	该签署区是否必须签署，默认值为 true（必须签） true - 是 false - 否场景对接说明详见：【选签（非必须签）】（该参数设置：false时）补充说明：常规场景都是必须签署，不需要额外指定该参数为 false，如果需要选签（非必须签）功能，则不允许设置自动落章。
	normalSignFieldConfig（点击“+”）			object	否	body	签章区配置（当signFieldType为0时，该参数必传）
		autoSign		boolbean	否	body	是否后台自动签章，默认值 false true - 后台自动签章（无感知），false - 签署页手动操作签章补充说明：当签署方为个人时，不支持自动签章。当签署方为机构（且非应用Id所属企业），自动签章需先经过印章授权，点击查看印章授权规则。当签署方为应用Id所属主体企业自身签署时，支持后台自动签章。
		freeMode		boolbean	否	body	是否自由签章，默认值 false true - 是，false - 否【注】指由用户选择是否签署，且不限签署位置和签署次数
		movableSignField		boolbean	否	body	是否可以移动签章区，默认值 false true - 可以移动，false - 固定位置
signFieldSize		int	否	body	签章区尺寸（正方形的边长，单位为px）补充说明：指定的签署区的宽度，高度等比缩放；不指定默认以印章原始大小加盖不能与signFieldWidth、signFieldHeight同时传入
signFieldWidth		int	否	body	签署区宽度（矩形的左右边距距离，单位为px）补充说明：印章需要自定义规格时传入该参数（根据指定的签署区宽高适配）；不指定默认以印章原始大小加盖与signFieldHeight搭配使用，但不能与signFieldSize同时传入
signFieldHeight		int	否	body	签署区高度（矩形的上下边距距离，单位为px）补充说明：印章需要自定义规格时传入该参数（根据指定的签署区宽高适配）；不指定默认以印章原始大小加盖与signFieldWidth搭配使用，但不能与signFieldSize同时传入
signFieldStyle		int32	否	body	签章区样式 1 - 单页签章区，2 - 骑缝签章区
assignedSealId		string	否	body	指定印章ID
availableSealIds		list	否	body	手动签章时页面可选的印章列表
orgSealBizTypes		string	否	body	可选机构印章类型（英文逗号分隔） ALL - 显示所有类型的印章（默认值） PUBLIC - 机构主体公章 CONTRACT - 合同专用章 FINANCE - 财务专用章 PERSONNEL - 人事专用章 COMMON - 其他类印章（无具体业务类型的章）
psnSealStyles		string	否	body	可选个人印章样式，默认值0和1（英文逗号分隔） 0 - 普通手写，1 - 印章，2 - AI手写
signFieldPosition		object	否	body	签章区位置
		acrossPageMode	string	否	body	骑缝模式 ALL-全部页，AssignedPages - 指定页码范围
		positionPage	string	否	body	签章区所在页码（1）当signFieldStyle为1即单页签章时，只能传单个页码（2）当signFieldStyle为2即骑缝签章时，且acrossPageMode为AssignedPages即指定页码范围时，连续页码可使用'-'指定页码范围，多个页码范围用逗号分隔，例如：1-3,6-10
		positionX	float	否	body	签章区所在X坐标（当signFieldStyle为2即骑缝签章时，该参数不生效，可不传值）
		positionY	float	否	body	签章区所在Y坐标
remarkSignFieldConfig（点击“+”）			object	否	body	备注区配置
		freeMode		boolbean	否	body	自由模式（由用户选择是否签署，且不限签署位置和签署次数） true - 是（自由模式下不需要传此对象中的其他参数） false - 否（默认值）
		inputType		int32	是	body	备注文字输入方式 1 - 手写抄录输入，2 - 键盘自由输入【注】inputType=2时，aiCheck和remarkContent参数值不生效
		aiCheck		int32	否	body	是否开启 AI 手写抄录校验， 0 - 不开启， 1 - 开启 AI 校验，2 - 强制 AI 校验【注】inputType=1时此参数必须传值
		movableSignField		boolbean	否	body	是否可以移动备注区，默认值 false true - 可以， false - 不可以
		remarkContent		string	否	body	预设待抄录信息，最多支持50个汉字（含标点符号），支持传换行符 \n 【注】inputType=1时此参数必须传值
	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 - 不固定位置
	signDatePositionX		float	否	body	签署日期所在位置X坐标
	signDatePositionY		float	否	body	签署日期所在位置Y坐标
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坐标

响应参数

展开全部参数参数名称		参数类型	必选	参数说明
code		int32	否	业务码，0表示成功
message		string	否	业务信息请根据 code 来判断错误情况，不应该依赖 message匹配，因为 message 可能会调整。
data（点击“+”展开详情）		array	否	业务数据
	signFieldId	string	否	签署区ID
	fileId	string	否	签署区所在文件ID
	psnId	string	否	签署区对应的签署人账号ID
	orgId	string	否	签署区对应的机构账ID

请求示例

{
    "signers": [
         {
            "signConfig": {
                "signOrder": 1
            },
            "orgSignerInfo": {
                "orgName": "******有限公司",
                "orgInfo": {
                    "orgIDCardNum": "911*****88",
                    "orgIDCardType": "CRED_ORG_USCC"
                },
                "transactorInfo": {
                    "psnAccount": "15*****50",
                    "psnInfo": {
                        "psnName": "张三"
                    }
                }
            },
            "signerType": 2,
            "signFields": [
                {
                    "customBizNum": "自定义编码001",
                    "fileId": "0d8b8cf3******a2f2afd1df",
                    "normalSignFieldConfig": {
                        "autoSign": false,
                        "assignedSealId": "",
                        "signFieldPosition": {
                            "positionPage": "1",
                            "positionX": 200,
                            "positionY": 200
                        },
                        "signFieldStyle": 1
                    },
                    "signDateConfig": {
                        "dateFormat": "yyyy-MM-dd HH:mm:ss",
                        "fontSize": 20,
                        "showSignDate": 1
                    }
                }
            ]
        }
    ]
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": [
        {
            "signFieldId": "8fd1*****ff25ef6d",
            "fileId": "0d8b8c******2afd1df",
            "psnId": "39c4d6*****9634438c8",
            "psnAccount": "153*****50",
            "orgId": "842ec******fc91662f",
            "orgName": "*****有限公司"
        }
    ]
}

错误码

点击查看错误码

合同文件签署服务API

追加签署区

接口描述

接口地址&请求方法

请求头格式

请求参数

响应参数

请求示例

响应示例

错误码