发起备注签署流程（按手机&邮箱）

文档变更

2022年时，一步发起备注签署变为发起备注签署流程（按手机&邮箱），以便开发者更容易理解，仅中文名称变更，其功能保持不变。

接口描述

此接口支持添加普通签署区同时指定备注签署区，让用户在签章过程中添加备注文字信息。

典型应用场景

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

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

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

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

<备注签署区>参数释义

通过接口参数 signfields 中的 fieldType 控制是否需要在签署流程中添加备注签署区，fieldType参数值填写为固定值2时添加备注签署区。

备注签署区关键参数：

1. 待签署文件：fileId

2. 备注签署区选项：remarkFieldConfig参数控制备注签署区具体的信息，包括备注签署区尺寸、备注文字的输入方式、预设待抄录信息、是否开启 AI 手写抄录校验等。

【注意事项】

（1）关于参数限制

1. 备注签署区的签署类型（signType）仅限传 1-单页签署，不支持传入0-不限、2-骑缝章；

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

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

（2）签署区配置参数

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

2. 是否开启 AI 手写抄录校验（aicheck）参数解释：

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

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

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

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

（3）流程中添加多个签署区

一个流程中支持添加多个数组对象的签署区，根据 fieldType 区分，传入值为2代表添加备注签署区，印章等其他签署区无需传入该参数。

接口地址&请求方式

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

请求方式：POST

请求头格式

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

请求参数

展开全部参数参数名称					类型	必选	参数类型	参数说明（左右拖动查看完整描述）
flowInfo					object	是	body	本次签署流程的基本信息
	businessScene				string	是	body	本次签署流程的文件主题名称查询此参数的效果示例注：名称不支持以下9个字符：/ \ : * " < > \| ？
	autoArchive				boolean	否	body	全部签章后流程自动完结，默认false。 true - 自动完结 false - 非自动完结 false时需开发者主动调用【完结签署流程】接口完结流程
	autoInitiate				boolean	否	body	是否自动开启，默认false。
	signValidity				int64	否	body	本次签署流程的截止时间。时间戳格式，单位：毫秒，默认永久有效。查询此参数的效果示例注：超过签署有效截止时间，则无法继续签署。
	contractValidity				int64	否	body	本次签署文件的到期时间。时间戳格式，单位：毫秒，默认永久有效。查询此参数的效果示例注：只有设置了contractValidity，才能设置续签提醒时间contractRemind。
	contractRemind				int32	否	body	本次签署的续签提醒时间。单位：小时，默认不提醒。注：时间区间[1-360]，可通过异步通知等方式触发续签通知
	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组织机构法定代表人授权书签署认证
willTypes		list	否	body	页面指定意愿认证方式，可指定类型如下： CODE_SMS 短信验证码 FACE_ZHIMA_XY 支付宝刷脸FACE_TECENT_CLOUD_H5 腾讯云刷脸FACE_FACE_LIVENESS_RECOGNITION e签宝刷脸 FACE_WE_CHAT_FACE 微信小程序刷脸 FACE_AUDIO_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）短信或邮件中的签署链接依然需要登录框。
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	签署方账号信息（平台方自动签署时，无需传入该参数；平台用户签署时，该参数必传）
		signerAccount			string	否	body	签署人真实信息，手机号或邮箱注：（1）传入手机号/邮箱（e签宝SaaS官网的登录手机号或邮箱）（2）当平台用户签署时该参数必传
		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	银行卡号（银行卡四要素认证时可传入）
authorizedAccount			string	否	body	签署主体真实信息，个人手机号、邮箱或机构名称注： 1、机构签署场景此字段必须传机构名称，个人签署场景可以不传或者传个人的手机号、邮箱。机构名词解释：企业、事业单位、机关、社会团体及其他依法成立的单位的统称。
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【护照】
noticeType			string	否	body	通知方式，可选择多种通知方式，逗号分割，1-短信，2-邮件注意：（1）可以通过此字段控制单个签署方的通知方式，不同的签署方可以设置不同的通知方式。详细规则【请点击】（2）短信或邮件中的签署链接依然需要登录框。
signfields				array	是	body	签署方的签署区列表数据
	fieldType			int32	否	body	签署区类型，默认值为0 0 - 普通签署区 2 - 备注签署区需要添加备注文字时请填写 2 需要普通签章时请填写0或不传此参数
	remarkFieldConfig			object	否	body	备注签署区配置项注：仅fieldType=2时此参数必传
		inputType		int32	是	body	备注文字输入方式 1 - 手写抄录输入 2 - 键盘自由输入（inputType=2时， aiCheck和remarkContent参数值不生效）
		aiCheck		int32	否	body	是否开启 AI 手写抄录校验， 0 - 不开启 1 - 开启 AI 校验 2 - 强制 AI 校验注：inputType=1时此参数必须传值
		remarkContent		string	否	body	预设待抄录信息，最多支持50个汉字（含标点符号）支持传换行符 \n 注：inputType=1时此参数必须传值
		remarkFieldWidth		int32	是	body	备注签署区的宽度
		remarkFieldHeight		int32	是	body	备注签署区的高度
		remarkFontSize		int32	否	body	备注文字大小，默认值11（px）
	fileId			string	是	body	待签署文件ID 可通过【上传本地文件】获取fileId。
	assignedPosbean			boolean	否	body	表示签署过程中，是否固定指定的签署区位置，默认为true。 true-固定签署区位置且无法移动， false-不固定签署区位置且签署时可自由移动注：当signType为1或者2时，该字段才会生效
	autoExecute			boolean	否	body	是否自动执行签署，默认false true-自动签署， false-手动签署。注： 1、平台方自动签署时，该字段必传，传入true； 2、SaaS API标准版产品，平台用户不支持自动签署
	actorIndentityType			int32	否	body	企业主体签约类型：0-个人盖章，2-机构盖章；默认是0 注： 1.签署主体是个人时，无需传入该参数，或者传0 2.备注签署区仅支持个人签署，当fieldType为2，仅限传0 3.非备注签署区签署主体是企业时，该字段必传，传入2
	sealIds			list	否	body	印章ids，用于手动签署时，指定企业印章进行展示，实现手动选择印章进行签署 (1)只支持签约主体为企业时指定印章，通过e签宝官网获取对应实名主体下的印章编号。 (2)支持传入多个印章id，入参格式：sealIds:["印章id1","印章id2",....]
	sealId			string	否	body	印章id，通过e签宝官网获取对应实名主体下的印章编号。注： 1、平台方自动盖章签署时，仅限传入企业公章，不支持指定企业法定代表人印章； 2、平台方自动盖章签署时，如果指定企业授权印章，签署后的签名信息，印章样式和数字证书均为授权企业主体所有，详细参考【印章授权说明】
sealType			string	否	body	签署方式，个人签署时支持多种签署方式，0-手绘签名，1-模板印章签名，多种类型时逗号分割，为空不限制
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	签署区的宽度
signDateBeanType			int 32	否	body	是否需要添加签署日期，0-禁止 1-必须 2-不限制，默认0
signDateBean			object	否	body	签署日期信息
	fontSize		int32	否	body	签章日期字体大小
	format		string	否	body	签章日期格式，支持的格式： yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd
	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个字符： / \ : * " < > \| ？
	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个字符： / \ : * " < > \| ？

响应参数

展开全部参数参数名称		类型	必选	参数说明（左右拖动查看完整描述）
code		int	是	业务码，0表示成功
message		string	否	业务信息
data		object	否	业务数据
	flowId	string	否	签署流程ID

请求示例

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

{
    "attachments": [
        {
            "attachmentName": "1",
            "fileId": "a5404c6b3ea640fbaeb8a426xxx"
        }
    ],
    "docs": [
        {
            "fileId": "a5404c6b3ea640fbaeb8a426xxx",
            "fileName": "xx验收单.pdf"
        }
    ],
    "copiers": [
        {
            "copierAccountId": "078f5ac93cb34c05aa0f67580xxx",
            "copierIdentityAccountId": "078f5ac93cb34c05aa0f67580b255xxx",
            "copierIdentityAccountType": 0
        }
    ],
    "flowInfo": {
        "autoInitiate": true,
        "businessScene": "xx验收场景",
        "contractRemind": 1,
        "contractValidity": 1629338251000,
        "flowConfigInfo": {
            "noticeDeveloperUrl": "http://xx.xx.xx.xxx:8081/CSTNotify/asyn/notify",
            "noticeType": "1,2,3",
            "redirectUrl": "",
            "signPlatform": "1,2",
            "willTypes": [
                "FACE_ZHIMA_XY"
            ],
            "personAvailableAuthTypes": [
                "PSN_FACEAUTH_BYURL",
                "PSN_TELECOM_AUTHCODE"
            ],
            "batchDropSeal": true,
            "orgAvailableAuthTypes": [
                "ORG_BANK_TRANSFER"
            ],
            "personAuthAdvancedEnabled": [
                "PSN_BANK4_AUTHCODE"
            ],
            "countdown": 5
        },
        "signValidity": 1671082947000
    },
    "signers": [
        {
            "platformSign": false,
            "signOrder": 1,
            "signerAccount": {
                "signerAccount": "152****4800"
            },
            "signfields": [
                {
                    "fieldType": "2",
                    "remarkFieldConfig": {
                        "inputType": "1",
                        "remarkContent": "预填信息",
                        "remarkFieldWidth": "300",
                        "remarkFieldHeight": "100",
                        "remarkFontSize": "11",
                        "aiCheck": "2"
                    },
                    "fileId": "a5404c6b3ea640fbaeb8a4261045a47f",
                    "posBean": {
                        "posPage": "1",
                        "posX": "300",
                        "posY": "200"
                    },
                    "sealType": "",
                    "signType": 1,
                    "width": 400
                }
            ],
            "thirdOrderNo": "xxxx"
        }
    ]
}

响应示例

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