追加备注签署区

接口描述

追加备注签署区是指创建签署流程后，向流程中添加用户备注的文字签署区。支持按手机号、邮箱和账号ID方式进行追加。

（区别于【发起备注签署流程】接口直接创建发起签署，本接口适用于分步流程，例如【创建签署流程（旧）】后，添加用户备注签署区（添加签署方信息、备注签署区属性信息等）

【典型应用场景】

一. 医疗行业：病历单、处方单、告知书等签署时，需要填写一段文字用于表明患者（患者家属）已知晓所签内容及风险，如“我已经阅读并悉知”，然后签字提交签署。

二. 保险行业：签署保单时，需要投保人抄录风险提示语，确保消费者对保险保障、收益的知情权，防止销售误导投保人。如：“本人已阅读保险条款、产品说明书和投保提示书，了解本产品的特点和保单利益的不确定性”。

三. 物流行业：在物流清单上备注清点信息，如“应收XX箱货物，实收XX箱”。

提示：备注签署区与签名签署区具备相等的法律效力，支持出证。

【接口调用注意事项】

一. 参数规则

1. 备注签署区的签署类型 signType 为 1-单页签署时，代表固定备注签署区的位置；

2. 备注签署区的签署类型 signType 为 0-不限时，代表自由添加备注文字（页面支持用户自由拖拽备注签署区的位置，且批注文字仅限键盘输入），此时无需传入备注签署区的位置信息PosBean参数；

3. 备注签署区内不能盖印章，传入的印章id、sealType等相关配置将失效；

4. 备注签署区不支持自动签署，设置的自动签署 autoExecute 相关参数将失效；

二. 备注签署区专有配置项(remarkFieldConfig)

1. 指定了输入方式 inputType为 2 - 键盘自由输入时，无法对输入的备注文字内容进行 AI 校验；

2. 是否开启 AI 手写抄录校验 aiCheck参数：

--传入值为 0 代表不开启校验；

--传入值为 1 时，开启 AI 手写抄录校验，连续3次校验不通过将弹窗提醒“监测到多次识别未通过，是否直接使用当前手写笔迹？”，确定后跳过该字的校验，下一个字继续执行 AI 校验；

--传入值为 2 时，强制 AI 手绘校验，若校验不通过，则会一直提示“识别失败，请重新书写”，直至校验通过。

3. 指定备注签署区坐标位置的与其他签名签署区规则相同，即根据posBean中的posX和posY的值决定，备注签署区的尺寸则是由 remarkFieldWidth（宽度）和 remarkFieldHeight（高度）决定，width参数不生效。

三. 是否支持一个流程中同时存在签名签署区和备注签署区？

支持同时添加，分别添加多个数据对象的签署区signfields参数即可，根据其中的fieldType区分，传入值为2代表为备注签署区，需要盖印章等其他签名签署区无需传入fieldType。

接口地址&请求方式

接口地址：/v2/signflows/{flowId}/signfields/handSign

请求方式：POST

请求头格式

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

请求参数

展开全部参数参数名称				类型	必选	参数类型	参数说明（左右拖动查看完整描述）
flowId				string	是	path	签署流程ID
signfields				array	是	body	签署区列表数据
	signType			int32	否	body	签署类型 0 -不限（不限用户增加批注的位置，可自由拖拽） 1 -单页签署（根据指定的位置坐标信息固定）
	fieldType			int32	否	body	签署区类型，请传固定值 2 0 - 普通签名签署区 2 - 备注签署区需要添加备注文字时请填写 2 需要普通签章时请填写0或不传此参数
	remarkFieldConfig			object	否	body	备注签署区专有配置项注：仅当fieldType=2时需要传此参数
		inputType		int32	是	body	备注文字输入方式 1 - 手写抄录输入 2 - 键盘自由输入（signType=0时只能传 2，传2时remarkContent和aiCheck参数无效）
		remarkContent		string	否	body	预设待抄录信息，最多支持50个汉字（含标点符号），支持传换行符 \n （inputType=1时此参数必须传值）
		aiCheck		int32	否	body	是否开启 AI 手写抄录校验， 0 - 不开启 1 - 开启 AI 校验 2 - 强制 AI 校验（inputType=1时此参数必须传值）
		remarkFieldWidth		int32	是	body	备注签署区的宽度
		remarkFieldHeight		int32	是	body	备注签署区的高度
		remarkFontSize		int32	否	body	备注文字大小，默认值11（px）
	fileId			string	是	body	待签署文件ID 可通过【上传本地文件】获取fileId。
	signerAccount			string	否	body	签署操作人真实信息，手机号或邮箱传入手机号/邮箱（后续签署后会绑定到e签宝官网的登录账号上，作为登录手机号/邮箱） signerAccountId与signerAccount二选一
	signerAccountId			string	否	body	签署操作人个人账号标识，即操作本次签署的个人传入e签宝SaaS官网的账号ID，即通过【获取认证链接】操作认证后生成的账号ID。 signerAccountId与signerAccount二选一
	authorizedAccount			string	否	body	签署主体真实信息，个人手机号、邮箱或机构名称注： 1、机构签署场景此字段必须传机构名称，个人签署场景可以不传或者传个人的手机号、邮箱。 2、机构包含：企业、律所、非工商社会组织等 authorizedAccountId与authorizedAccount二选一
	authorizedAccountId			string	否	body	签约主体账号标识，即本次签署对应任务的归属方，默认是签署操作人个人注：（1）传入e签宝SaaS官网的账号ID，即通过【获取认证链接】操作认证后生成的账号ID。（2）如果是企业机构签署，请传企业机构账号orgId。 authorizedAccountId与authorizedAccount二选一
	signerAccountInfo			object	否	body	签署人基本信息注：传入个人的基本信息，会代入到签署页面里。
		name		string	否	body	个人姓名
		certNo		string	否	body	个人证件号
		certType		string	否	body	个人证件类型 CRED_PSN_CH_IDCARD【大陆身份证】CRED_PSN_CH_TWCARD【台湾来往大陆通行证】 CRED_PSN_CH_MACAO【澳门来往大陆通行证】 CRED_PSN_CH_HONGKONG【香港来往大陆通行证】 CRED_PSN_PASSPORT【护照】
		bankCardNo		string	否	body	银行卡号（银行卡四要素认证时可传入）
	orgAccountInfo			object	否	body	机构签署主体基本信息注：当签署方为机构的情形，可以传入机构名称对应的其他基本信息，会带入到签署页面中
		certNo	string	否	body	组织机构证件号
		certType	string	否	body	组织机构证件类型 CRED_ORG_USCC【统一社会信用代码】 CRED_ORG_REGCODE【工商注册号】
		legalRepName	string	否	body	法定代表人姓名
		legalRepCertNo	string	否	body	法定代表人证件号
		legalRepCertType	string	否	body	法定代表人证件类型，不传默认：中国大陆身份证 CRED_PSN_CH_IDCARD【中国大陆身份证】CRED_PSN_CH_TWCARD【台湾来往大陆通行证】 CRED_PSN_CH_MACAO【澳门来往大陆通行证】 CRED_PSN_CH_HONGKONG【香港来往大陆通行证】 CRED_PSN_PASSPORT【护照】
actorIndentityType			int32	否	body	机构签约类别，当签约主体为机构时必传：2-机构盖章，3-法定代表人盖章
assignedPosbean			boolean	否	body	表示签署过程中，是否固定指定的签署区位置，默认为true。 true-固定签署区位置且无法移动， false-不固定签署区位置且签署时可自由移动注：当signType为1时，该字段才会生效
order			int32	否	body	签署区顺序，默认1,且不小于1，顺序越小越先处理
forceReadTime			int32	否	body	签署强制阅读时间, 单位为秒，不传默认为0，最大999 注：（1）签署页提交倒计时，仅限平台用户手动签署时可用。（2）与流程中的签署配置项countdown字段作用相同，只是此字段在签署人维度控制，优先级更高。
posBean			object	否	body	签署区位置信息 signType为0时自由批注，该参数无需传入； signType为1时固定页码, 页码和XY坐标不能为空
	posPage		string	否	body	页码（不小于1的自然数，不可超出文件总页数）与参数signType组合使用，详见接口描述
	posX		float	否	body	x坐标，默认空注：指定XY坐标定位：【请点击】根据关键字辅助定位接口【请点击】
	posY		float	否	body	y坐标
	width		float	否	body	签署区宽，默认印章宽度
	addSignTime		boolean	否	body	签章日期，默认跟随在印章底部，默认false。 true-显示日期 false-不显示日期
	signTimeFormat		string	否	body	签章日期格式，yyyy-MM-dd HH:mm:ss
signDateBeanType			int	否	body	是否需要添加签署日期，默认0 0-禁止 1-必须 2-不限制
signDateBean			Object	否	body	签章日期信息，骑缝章默认不展示日期
	fontSize		int32	否	body	签章日期字体大小,默认12
	format		string	否	body	签章日期格式，支持的格式： yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd
	posPage		int32	否	body	页码信息，如需指定日期盖章位置，则需传入日期盖章页码和坐标（日期页码与印章页码需相同）
	posX		float	否	body	x坐标，默认0（如果X和Y坐标不传入，签署日期默认在签署区下方）
	posY		float	否	body	y坐标，默认0
sealType			string	否	body	签署方式，个人签署时支持多种签署方式，0-手绘签名，1-模板印章签名，多种类型时逗号分割，为空不限制
sealIds			list	否	body	印章ids，用于手动签署时，指定企业印章进行展示，实现手动选择印章进行签署 (1)只支持签约主体为企业时指定印章，通过e签宝官网获取对应实名主体下的印章编号。 (2)支持传入多个印章id，入参格式：sealIds:["印章id1","印章id2",....]
thirdOrderNo			string	否	body	第三方流水号注： 1.该字段属于自定义内容，传入的内容会在后续【签署人签署完成回调通知】以及【查询签署区】【查询签署人】接口中原样返回。可以通过该字段的传值标识自己的业务以及签署方信息。 2.须保证同流程中相同签署人、相同签约主体、相同签署顺序的任务，对应的该字段值唯一举例：N001-15300001111（自己的标识+手机号）

响应参数

展开全部参数参数名称			类型	必选	参数说明（左右拖动查看完整描述）
code			int	否	业务码，0表示成功
message			string	否	信息
data			object	否	业务信息
	signfieldBeans		array	否	签署区列表数据
	accountId	string	否	用户ID
	fileId	string	否	文档ID
	signfieldId	string	否	签署区id

请求示例

POST https://openapi.esign.cn/v2/signflows/17879c7b7c56455abxxx/signfields/handSign

{
    "signfields":[
        {
            "fileId":"b84cae33d3fb45a2xx",
            "fieldType":"2",
            "remarkFieldConfig":{
                "inputType":"1",
                "remarkContent":"我已经阅读并知悉",
                "remarkFieldWidth":"300",
                "remarkFieldHeight":"100",
                "aiCheck":"2"
            },
            "signerAccount":"183xxxx0000",
            "assignedPosbean":false,
            "posBean":{
                "addSignTime":true,
                "posPage":"1",
                "posX":200.25,
                "posY":214.45
            },
            "signType":1
        }
    ]
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "signfieldBeans": [
            {
                "signfieldId": "c6ad0edd99694c1284xxx",
                "fileId": "b84cae33d3fb45a2b2162a93xxx",
                "accountId": "c7e0029472914ce4ab33deeaxxx"
            }
        ]
    }
}