基础介绍
发起签署接口支持添加普通签署区同时指定备注签署区,让用户在签章过程中添加备注文字信息。
典型应用场景
1. 医疗行业:病历单、处方单、告知书等签署时,需要填写一段文字用于表明患者(患者家属)已知晓所签内容及风险,如“我已经阅读并悉知”,然后签字提交签署。
2. 保险行业:签署保单时,需要投保人抄录风险提示语,确保消费者对保险保障、收益的知情权,防止销售误导投保人。如:“本人已阅读保险条款、产品说明书和投保提示书,了解本产品的特点和保单利益的不确定性”。
3. 物流行业:在物流清单上备注清点信息,如“应收XX箱货物,实收XX箱”。
注:备注签署区不支持自动签署,必须让用户在页面手动写入。且备注签署只支持个人签署方,不支持机构。
效果展示
其中【承诺】、【阅读】等字样为用户在备注区手写抄录的文字;承诺人签名:“张三”为用户在签章区手写的签名。
(本图仅为效果展示案例,具体业务设计需遵照自身实际需求)
API接口
API接口(点击直接跳转相关API文档) | API描述 | 是否必需 |
此接口用来发起签署,发起成功后会返回签署流程标识:signFlowId。 | 必需 | |
此接口获取签署方签署页面链接,可用于签署或预览。 | 按需 |
基于文件发起签署接口代码案例
相关参数
- signFieldType(签署区类型,默认值为 0;0 - 签章区(用于加盖印章或签名),1 - 备注区(用于添加备注文字信息)
- remarkSignFieldConfig 备注区配置项(指定signFieldType为 1 - 备注区时,该参数为必传项)
注:备注区配置项中--aiCheck(是否开启手写抄录 AI 校验)参数解释:
- 传入值为 0 :代表不开启校验;
- 传入值为 1 :开启 AI 手写抄录校验,连续3次校验不通过将弹窗提醒“监测到多次识别未通过,是否直接使用当前手写笔迹?”,确定后跳过该字的校验,下一个字继续执行 AI 校验;
- 传入值为 2 :强制 AI 手绘校验,若校验不通过,则会一直提示“识别失败,请重新书写XX”,直至校验通过。
手写抄录
代码案例为用户在页面手写抄录方式备注签署,并由开发者提前指定好备注位置。
- signFieldType 设置为:1(备注区);
- inputType 设置为:1(手写抄录方式);
- aiCheck 选择是否开启AI手绘;
- remarkContent 设置:客户在页面需要待抄录的信息;
- movableSignField (备注区是否可以移动)按照需求传入,如果希望用户在页面可以调整位置传入:true;
- remarkFontSize、signFieldWidth、signFieldHeight 传入需要的文字字号、备注区域宽高;
- signFieldPosition 设置备注区的页码和坐标位置信息。
"signFieldType": 1,
"remarkSignFieldConfig": {
"freeMode": false,
"inputType": 1,
"aiCheck": 1,
"remarkContent": "承诺",
"movableSignField": true,
"remarkFontSize": 12,
"signFieldHeight": "20",
"signFieldWidth": "30",
"signFieldPosition": {
"positionPage": "1",
"positionX": 190,
"positionY": 542
}
}
键盘输入
键盘输入方式不能预设待抄录信息,是由用户自由输入内容写入页面(一次最多输入50个字)。代码案例为用户在页面键盘输入方式备注签署,并由用户自由备注在任意位置,开发者不指定位置。
- signFieldType 设置为:1(备注区);
- freeMode 设置为:true,自由备注在任意位置。
- inputType 设置为:2(键盘输入方式);
- remarkFontSize、signFieldWidth、signFieldHeight 传入需要的文字字号、备注区域宽高。
"signFieldType": 1,
"remarkSignFieldConfig": {
"freeMode": true,
"inputType": 2,
"remarkFontSize": 12,
"signFieldHeight": "20",
"signFieldWidth": "100"
}