数据结构

被代理机构在电子签平台的机构编号，集团代理下场景必传

• HANDWRITE-手写签名
• ESIGN-个人印章类型
• OCR_ESIGN-AI智能识别手写签名
• SYSTEM_ESIGN-系统签名

在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:

0：企业

1：个人

3：企业“授权签”注：类型为3（企业“授权签”）时，此接口会默认完成该签署方的签署。“授权签”仅进行盖章操作，不能“授权签”名。

7: 个人“授权签”，适用于个人“授权签”场景。注: 个人“授权签”场景为白名单功能，使用前请联系对接的客户经理沟通。

签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。

签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此合同签署方。

组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。

【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体

• 个人签名/印章
• 企业印章
• 骑缝章等签署控件

签署方经办人的证件类型，支持以下类型，样式可以参考常见个人证件类型介绍
<ul>

注: 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人至少要过一次大陆的海关才能使用。

签署方经办人的证件号码，应符合以下规则

• 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
• 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
• 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。

通知签署方经办人的方式, 有以下途径:

• SMS : (默认)短信
• EMAIL : 邮箱
• ALL : 短信+邮箱
• NONE : 不通知

注意：
如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信

枚举值：

• SMS： 短信通知
• EMAIL： 邮件通知
• ALL： 短信+邮件通知
• NONE： 不做任何形式的通知

收据场景设置签署人角色类型, 可以设置如下类型:

• 1 :收款人
• 2 :开具人
• 3 :见证人

可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。

注: 如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的

【已不再使用】签署意愿确认渠道，默认为WEIXINAPP:人脸识别

注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置

签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。

若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：

• 合同页数少于等于2页，阅读时间为3秒；
• 合同页数为3到5页，阅读时间为5秒；
• 合同页数大于等于6页，阅读时间为10秒。

签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得

注：
如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）

在企微场景下使用，需设置参数为WEWORKAPP，以表明合同来源于企微。

在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。

可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人等。
详细操作可以参考开发者中心的ApproverOption结构体。

【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】指定个人签署方查看合同的校验方式,可以传值如下:

• 1 : （默认）人脸识别,人脸识别后才能合同内容
• 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）

• 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
• 此字段可传多个校验方式

【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】您可以指定签署方签署合同的认证校验方式，可传递以下值：

• 1：人脸认证，需进行人脸识别成功后才能签署合同；
• 2：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；
• 3：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）
• 5：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）
• 6：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）

默认为：
1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)

注：

1. 用模板创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在创建合同重新指定无效
2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考运营商支持列表类得到具体的支持说明
3. 校验方式不允许只包含设备指纹识别和设备面容识别，至少需要再增加一种其他校验方式。
4. 设备指纹识别和设备面容识别只支持小程序使用，其他端暂不支持。

此签署人（员工或者个人）签署前，是否需要发起方企业审批，取值如下：

• false：（默认）不需要审批，直接签署。
• true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。

• 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
• 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。

【在用文件发起合同场景下才有效】
在调用用PDF文件创建签署流程创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID或者印章类型）或签名方式。

注：参考文档和使用示例

签署须知：支持传入富文本，最长字数：500个中文字符

签署人的签署截止时间，格式为Unix标准时间戳（秒）

注: 若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同

【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

• 单行文本控件
• 多行文本控件
• 勾选框控件
• 数字控件
• 图片控件

具体使用说明可参考为签署方指定填写控件

注：此参数仅在通过文件发起合同或者合同组时生效

进入签署流程的限制，目前支持以下选项：

• 空值（默认） :无限制，可在任何场景进入签署流程。
• link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。

快速注册相关信息

是否不保存联系人
默认 false 保存联系人 true 不保存联系人

设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。
联系人查看可登录电子签控制台 进行查看。
如下图位置：

客户指定的邮箱信息

签署方是否可以拒签

• false : ( 默认)可以拒签
• true :不可以拒签

签署方是否可以转他人处理

• false : ( 默认)可以转他人处理
• true :不可以转他人处理

允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑

签署人信息补充类型，默认无需补充。

• 1 : 动态签署人（可发起合同后再补充签署人信息）注：企业“授权签”不支持动态补充

签署人阅读合同限制参数

取值：

• LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底
• LimitReadTime，阅读合同仅限制阅读时长
• LimitBottom，阅读合同仅限制必须阅读到底
• NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）

禁止在签署过程中添加签署日期控件

前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）：

• 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件
• 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件

签署人手机号传参模式

枚举值：

• REPLACE： 接受已有认证手机号并替换
• GIVEN： 以客户入参输入手机号为主
• VALIDATE： 若与认证手机号不一致则报错
• ""： 不走手机号传参模式

默认值：""

会触发手机号传参模式的前提是：签署人是指定了具体身份信息的

• 在指定签署人姓名，证件号的情况下会触发

在嵌入式文件发起下,若合同是通过文件,当签署人控件指定了印章类型（或印章Id）,在嵌入页面上是否能修改

【仅 SignBeanTag=1 时有效】 签署方自行添加签署印章类控件（SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL）时，「盖章区适配签署方印章尺寸」开关的控制策略

枚举值：

• 0： 默认关闭，可开启。与现网一致
• 1： 关闭且置灰——按控件默认的4.2cm尺寸盖章，签署方无法开启开关
• 2： 默认开启且可修改——默认按印章实际尺寸盖章，签署方可手动关闭
• 3： 开启且置灰——强制按印章实际尺寸盖章，签署方不可修改。

默认值：0

个人签署人姓名，如果传入，必须是证件上的真实中文名；中文名最长 25 个字符；

参与者类型，用于区分个人或企业，可选类型如下:
0：企业
1：个人

企业签署方名称。长度不超过 200 个字符。
如果名称中包含英文括号()，请使用中文括号（）代替。
如果签署方是企业签署方(approverType = 0 )， 则企业名称必填。

签署人手机号，必须是合法手机号。

签署人邮箱， 必须是合法邮箱格式。

签署方经办人的证件类型，支持以下类型，样式可以参考常见个人证件类型介绍

• ID_CARD 中国大陆居民身份证 (默认值)
• HONGKONG_AND_MACAO 港澳居民来往内地通行证
• HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
• OTHER_CARD_TYPE 其他证件

签署方经办人的证件号码，应符合以下规则

• 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
• 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
• 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。

当前参与者的签署时间，Unix 秒级时间戳。

归档合同id

合同处理结果

枚举值：

• 0： 成功
• 1： 失败

业务自定义id

资源ID列表

错误信息

扩展服务类型，和入参一致

扩展服务名称

授权员工列表

授权企业列表（企业“授权签”时，该字段有值）

授权员工列表总数

授权企业列表总数

• 0：未选择授权方式（默认值）
• 1：上传授权书
• 2：法人授权
• 3：法人认证

• 0：未提交授权书（默认值）
• 1：审核通过
• 2：审核驳回
• 3：审核中
• 4：AI识别中
• 5：客户确认AI信息

“授权签”开通个人用户信息, 包括名字,身份证等

是否回调证书信息:

• false: 不需要(默认)
• true:需要

注：该字段已经失效，请勿设置此参数。

是否支持用户自定义签名印章:

• false: 不能自己定义(默认)
• true: 可以自己定义

回调中是否需要“授权签”将要使用的印章(签名) 图片的 base64:

• false: 不需要(默认)
• true: 需要

开通时候的身份验证方式, 取值为：

• WEIXINAPP : 微信人脸识别
• INSIGHT : 慧眼人脸识别
• TELECOM : 运营商三要素验证

• 如果是小程序开通链接，仅支持 WEIXINAPP 。为空默认 WEIXINAPP
• 如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT

设置用户“授权签”合同的扣费方式。

• 1: (默认)使用合同份额进行扣减

开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。

注：仅支持H5开通场景, 跳转链接仅支持 https:// , qianapp:// 开头

跳转场景：

• 贵方H5 -> 腾讯电子签H5 -> 贵方H5 : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。
• 贵方原生App -> 腾讯电子签H5 -> 贵方原生App : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。APP拦截地址跳转可参考：返回应用JumpUrl格式

成功结果返回：
若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：appendResult=qian。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess

• Processing
• Create
• Submit
• Authorization
• Failed

任务状态名称	任务状态详情
Processing	企业认证任务处理中，用户调用了CreateBatchOrganizationRegistrationTasks接口，但是任务还在处理中的状态
Create	创建企业认证链接任务完成，可以调用生成任务链接接口
Submit	企业认证任务已提交,到如下界面之后，会变为这个状态
Authorization	企业认证任务认证成功,点击下图下一步，进入到授权书上传或者法人认证，则会变为这个状态
Failed	企业认证任务失败

• 0: 还没有发起
• 1: 等待签署
• 2: 部分签署
• 3: 拒签
• 4: 已签署
• 5: 已过期
• 6: 已撤销
• 7: 还没有预发起
• 8: 等待填写
• 9: 部分填写
• 10: 拒签
• 11: 已解除

• CloudEnterprise: 企业版合同
• SingleSignature: 单方签章
• CloudProve: 签署报告
• CloudOnlineSign: 腾讯会议在线签约
• ChannelWeCard: 微工卡
• SignFlow: 合同套餐
• SignFace: 签署意愿（人脸识别）
• SignPassword: 签署意愿（密码）
• SignSMS: 签署意愿（短信）
• PersonalEssAuth: 签署人实名（腾讯电子签认证）
• PersonalThirdAuth: 签署人实名（信任第三方认证）
• OrgEssAuth: 签署企业实名
• FlowNotify: 短信通知
• AuthService: 企业工商信息查询

合同流程ID，为32位字符串。

撤销失败原因

合同流程名称

被抄送方手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。

被抄送方姓名。
抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。

被抄送方类型, 可设置以下类型:

• 0 :个人抄送方
• 1 :企业员工抄送方

被抄送方权限, 可设置如下权限:

• 0 :可查看合同内容
• 1 :可查看合同内容也可下载原文

通知签署方经办人的方式, 有以下途径:

• sms : (默认)短信
• none : 不通知

被抄送方企业名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。

注意:
此为白名单功能，需要联系客户经理，开通白名单后才能使用。
使用文档 签署方/抄送方仅指定企业名称发起合同

合同风险审查清单分组名称，每个分组下可以包含多个检查点

合同风险审查清单检查点列表，每个检查点定义了一个具体的风险项

合同风险审查清单检查点名称

合同风险审查清单检查点详细描述，说明具体风险信息

合同风险审查清单检查点对应的风险等级，一般分为 高风险、中风险、一般风险

合同风险审查清单检查点ID，创建清单时无需填写

合同风险审查清单检查点是否不可缺失，若为true，相关条款未出现在内容中，视作风险

合同风险审查清单检查点是否要求和参考条款一致

合同风险审查清单检查点参考条款，用于辅助审查

合同风险审查清单检查点固定修改建议，优先级高于AiSuggestion

合同风险审查清单检查点AI修改建议提示，会参考该配置生成对应的修改建议

合同风险审查清单检查点表现标签，用于自定义不同的风险类型

合同对比差异点唯一ID。

对比前后差异类型，具体如下：

• add：新增
• change：变更
• delete：删除

对比内容类型，具体如下：

• text：文本
• table：表格
• picture：图片

原文文本。

对比文本。

合同文本的格式类型。
类型如下：

• 0：段落（正文）
• 1：标点符号
• 2：页眉页脚
• 3：目录
• 4：印章
• 5：序号
• 6：水印
• 7：下划线内容（填写区）

页码：对比点所在页码。

如果是Component填写控件类型，则可选的字段为：

• TEXT : 普通文本控件，输入文本字符串；
• MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
• CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
• FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
• DYNAMIC_TABLE : 动态表格控件；
• ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
• SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
• DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
• WATERMARK : 水印控件；只能分配给发起方，必须设置ComponentExtra；
• DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
• VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

如果是SignComponent签署控件类型，
需要根据签署人的类型可选的字段为

• 企业方

  • SIGN_SEAL : 签署印章控件；
  • SIGN_DATE : 签署日期控件；
  • SIGN_SIGNATURE : 用户签名控件；
  • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
  • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
  • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
  • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
  • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
  • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
  • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

• 个人方

  • SIGN_DATE : 签署日期控件；
  • SIGN_SIGNATURE : 用户签名控件；
  • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
  • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
  • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
  • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
  • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；

注：表单域的控件不能作为印章和签名控件

在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

在绝对定位方式方式下，指定控件所在PDF文件上的页码
在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

注：

1. 页码编号是从1开始编号的。
2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

控件生成的方式：

• NORMAL : 绝对定位控件
• FIELD : 表单域
• KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

控件唯一ID。

在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

例：

• 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
• 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

注：控件ID可以在一个PDF中不可重复

点击查看ComponentId在模板编辑页面的位置

在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

注：控件名可以在一个PDF中可以重复

点击查看ComponentName在模板页面的位置

如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

• false（默认）：可以不填写
• true ：必须填写此填写控件

在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

• Font：目前只支持黑体、宋体、仿宋
• FontSize： 范围6 :72
• FontAlign： Left/Right/Center，左对齐/居中/右对齐
• FontColor：字符串类型，格式为RGB颜色数字
• Bold是否加粗：true/false

ComponentType为DATE时，支持以下参数：

• Font：目前只支持黑体、宋体、仿宋
• FontSize： 范围6 :72

ComponentType为WATERMARK时，支持以下参数：

• Font：目前只支持黑体、宋体、仿宋
• FontSize： 范围6 :72
• Opacity： 透明度，范围0 :1
• Rotate： 水印旋转角度，范围0 :359
• Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
• Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
• SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

ComponentType为FILL_IMAGE时，支持以下参数：

• NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
• FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

ComponentType为SELECTOR时，支持以下参数：

• WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以通过ComponentTypeLimit参数控制签名方式

• HANDWRITE : 需要实时手写的手写签名
• HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
• OCR_ESIGN : AI智能识别手写签名
• ESIGN : 个人印章类型
• SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
• IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

• OFFICIAL : 企业公章
• CONTRACT : 合同专用章
• FINANCE : 财务专用章
• PERSONNEL : 人事专用章
• OTHER : 其他

ComponentType为SIGN_DATE时，支持以下参数：

• Font :字符串类型目前只支持"黑体"、"宋体"、"仿宋"，如果不填默认为"黑体"
• FontSize : 数字类型，范围6-72，默认值为12
• FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
• Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”，”yyyy m d HH:MM:SS”，”yyyy/m/d HH:MM:SS”，”yyyy-m-d HH:MM:SS”，”yyyy.m.d HH:MM:SS”。
• Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

• PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

• Opacity：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度

签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

• UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

• Values：签署意见预设的需要用户填写的文本
• ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）
• SignMethod：签署方式，目前支持1-词组拼接方式

关键字模式下支持关键字找不到的情况下不进行报错的设置

• IgnoreKeywordError :1-关键字查找不到时不进行报错

ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

• Children: 绝对定位模式下，用来指定此签批控件的组合子控件
参数样例：
{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
• ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
ChildrenComponent结构体定义:

字段名称	类型	描述
ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
ComponentName	string	子控件名称
Placeholder	string	子控件提示语
ComponentValue	string	子控件值（签署方不可设置）
ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
ComponentWidth	float	控件宽
ComponentHeight	float	控件高
ComponentExtra	string	控件的附属信息，根据ComponentType设置

参数样例：

输入:

{    ChildrenComponents: [        {            ComponentType: SIGN_SIGNATURE,            ComponentName: 个人签名,            Placeholder: 请签名,            ComponentOffsetX: 10,            ComponentOffsetY: 30,            ComponentWidth: 119,            ComponentHeight: 43,            ComponentExtra: {\ComponentTypeLimit:[\SYSTEM_ESIGN]}        },        {            ComponentType: SIGN_SELECTOR,            ComponentName: 是否同意此协议,            Placeholder: ,            ComponentOffsetX: 50,            ComponentOffsetY: 130,            ComponentWidth: 120,            ComponentHeight: 43,            ComponentExtra: {\Values:[\同意,\不同意,\再想想],\FontSize:12,\FontAlign:\Left,\Font:\黑体,\MultiSelect:false}        },        {            ComponentType: SIGN_MULTI_LINE_TEXT,            ComponentName: 批注附言,            Placeholder: ,            ComponentOffsetX: 150,            ComponentOffsetY: 300,            ComponentWidth: 200,            ComponentHeight: 86,            ComponentExtra:         }    ]}

在通过接口拉取控件信息场景下，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，发起合同时候不要填写此字段留空即可

控件填充vaule，ComponentType和传入值类型对应关系：

• TEXT : 文本内容
• MULTI_LINE_TEXT : 文本内容，可以用 \n 来控制换行位置
• CHECK_BOX : true/false
• FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
• SELECTOR : 选项值
• DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
• DATE : 格式化为：xxxx年xx月xx日（例如2024年05年28日）
• SIGN_SEAL : 印章ID，于控制台查询获取， 点击查看在控制台上位置
• SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取， 点击查看在控制台上位置

控件值约束说明：

如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
注意： 向左调整设置为负数， 向右调整设置成正数

如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
注意： 向上调整设置为负数， 向下调整设置成正数

如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

• Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
• Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

• Middle :居中
• Below :正下方
• Right :正右方
• LowerRight :右下角
• UpperRight :右上角。

如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

注意：关键字索引是从0开始计数的

web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

• false（默认）：不锁定控件值，允许在页面编辑控件值
• true：锁定控件值，在页面无法编辑控件值

web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

• false（默认） :可以移动和删除控件
• true : 禁止移动和删除控件

【暂未使用】日期签署控件的字号，默认为 12

【暂未使用】第三方应用集成平台模板控件 ID 标识

【暂未使用】第三方应用集成中子客企业控件来源。

• 0 :平台指定；
• 1 :用户自定义

控件类型，支持以下类型

• SIGN_SEAL : 印章控件
• SIGN_PAGING_SEAL : 骑缝章控件
• SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件
• SIGN_SIGNATURE : 用户签名控件

签署控件类型的值(可选)，用于限制签署时印章或者签名的选择范围

1.当 ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时，可指定印章类型或具体企业印章Id。具体场景与规则说明如下：

指定印章类型:可传入以下枚举值来限制印章类型

• OFFICIAL : 企业公章
• CONTRACT : 合同专用章
• FINANCE : 财务专用章
• PERSONNEL : 人事专用章
• OTHER : 其他

指定具体印章Id:可通过传递 ComponentValue 来指定具体的企业印章ID（支持传入多个）
限制条件：

• 可为本企业（即发起方）的签署人指定本企业具体印章ID。
• 主企业发起或集团账号主代子发起的业务场景下，也支持指定子企业的具体印章ID。
• 他方企业签署人不支持指定具体印章ID

注意： 若请求中同时指定了具体的印章ID和印章类型，将以印章ID为准，传入的印章类型参数会被自动忽略。

2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）

• HANDWRITE : 需要实时手写的手写签名
• HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
• OCR_ESIGN : OCR印章（智慧手写签名）
• ESIGN : 个人印章
• SYSTEM_ESIGN : 系统印章

合同文件的资源id，使用UploadFiles 上传文件返回resourceId，目前一个合同只能支持一个资源ID。

合同名称，不传时系统会使用合同资源文件名作为合同名称；最终合同名称不能为空；长度不能超过200，只能由中文、字母、数字和下划线组成。

合同类型，自定义文本字符串，长度不能超过200。

调用方业务系统中的合同业务编号，可以用于外部系统和归档合同做关联，长度不超过 128 字节

合同发起方/创建人名称，用于归档合同展示和检索，长度不超过 32 字符

签署人信息列表，用于记录合同由哪些个人或企业签署，最多 50 个参与者。

关注人信息列表，用于记录合同关注对象，最多 50 个关注者。

调用方自定义透传数据，可用于保存业务扩展信息，长度不超过 20480 字节。

合同描述/备注信息，长度不超过 1000 个字符

合同签署完成时间，Unix 秒级时间戳

合同发起时间/合同原始创建时间，Unix 秒级时间戳

是否允许修改发起合同时确认弹窗的合同信息（合同名称、合同类型、签署截止时间），若不允许编辑，则表单字段将被禁止输入。

true：允许编辑
false：不允许编辑（默认值）

是否允许编辑模板控件

true:允许编辑模板控件信息

false:不允许编辑模板控件信息（默认值）

发起页面隐藏合同名称展示

true:发起页面隐藏合同名称展示

false:发起页面不隐藏合同名称展示（默认值）

发起页面隐藏合同类型展示

true:发起页面隐藏合同类型展示

false:发起页面不隐藏合同类型展示（默认值）

发起页面隐藏合同截止日期展示

true:发起页面隐藏合同截止日期展示

false:发起页面不隐藏合同截止日期展示（默认值）

发起页面允许跳过添加签署人环节

true:发起页面允许跳过添加签署人环节

false:发起页面不允许跳过添加签署人环节（默认值）

文件发起页面跳过文件上传步骤

true:文件发起页面跳过文件上传步骤

false:文件发起页面不跳过文件上传步骤（默认值）

禁止编辑填写控件

true:禁止编辑填写控件

false:允许编辑填写控件（默认值）

定制化发起合同弹窗的描述信息，描述信息最长500字符

禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”

是否可以编辑签署人包括新增，修改，删除

• （默认） false -可以编辑签署人
• true - 禁止编辑签署人

注意：如果设置参数为 true， 则 参数签署人 FlowApproverList 不能为空

禁止设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板

在发起流程的可嵌入页面要隐藏的控件列表，和 ShowComponentTypes 参数 只能二选一使用（注:
空数组代表未指定），具体的控件类型如下

• SIGN_SIGNATURE : 个人签名/印章
• SIGN_SEAL : 企业印章
• SIGN_PAGING_SEAL : 骑缝章
• SIGN_LEGAL_PERSON_SEAL : 法定代表人章
• SIGN_APPROVE : 签批
• SIGN_OPINION : 签署意见
• SIGN_PAGING_SIGNATURE : 手写签名骑缝控件
• BUSI-FULL-NAME : 企业全称
• BUSI-CREDIT-CODE : 统一社会信用代码
• BUSI-LEGAL-NAME : 法人/经营者姓名
• PERSONAL-NAME : 签署人姓名
• PERSONAL-MOBILE : 签署人手机号
• PERSONAL-IDCARD-TYPE : 签署人证件类型
• PERSONAL-IDCARD : 签署人证件号
• TEXT : 单行文本
• MULTI_LINE_TEXT : 多行文本
• CHECK_BOX : 勾选框
• SELECTOR : 选择器
• DIGIT : 数字
• DATE : 日期
• FILL_IMAGE : 图片
• ATTACHMENT : 附件
• EMAIL : 邮箱
• LOCATION : 地址
• EDUCATION : 学历
• GENDER : 性别
• DISTRICT : 省市区

在发起流程的可嵌入页面要显示的控件列表，和 HideComponentTypes 参数 只能二选一使用（注:
空数组代表未指定），具体的控件类型如下

• SIGN_SIGNATURE : 个人签名/印章
• SIGN_SEAL : 企业印章
• SIGN_PAGING_SEAL : 骑缝章
• SIGN_LEGAL_PERSON_SEAL : 法定代表人章
• SIGN_APPROVE : 签批
• SIGN_OPINION : 签署意见
• SIGN_PAGING_SIGNATURE : 手写签名骑缝控件
• BUSI-FULL-NAME : 企业全称
• BUSI-CREDIT-CODE : 统一社会信用代码
• BUSI-LEGAL-NAME : 法人/经营者姓名
• PERSONAL-NAME : 签署人姓名
• PERSONAL-MOBILE : 签署人手机号
• PERSONAL-IDCARD-TYPE : 签署人证件类型
• PERSONAL-IDCARD : 签署人证件号
• TEXT : 单行文本
• MULTI_LINE_TEXT : 多行文本
• CHECK_BOX : 勾选框
• SELECTOR : 选择器
• DIGIT : 数字
• DATE : 日期
• FILL_IMAGE : 图片
• ATTACHMENT : 附件
• EMAIL : 邮箱
• LOCATION : 地址
• EDUCATION : 学历
• GENDER : 性别
• DISTRICT : 省市区

发起流程的可嵌入页面结果页配置

签署控件的配置信息，用在嵌入式发起的页面配置，包括

• 签署控件 是否默认展示日期.

是否禁止编辑（展示）水印控件属性

• （默认） false -否
• true - 禁止编辑

隐藏操作步骤: 具体的控件类型如下

• 1 : 选择文件及签署方
• 2 : 补充文件内容
• 4 : 发起前合同信息与设置确认

本企业简称，注：仅对新版页面生效

发起后签署码隐藏，默认false，注：仅对新版页面生效

发起成功后是否预览合同

• （默认） false -否
• true - 展示预览按钮

发起成功之后是否签署合同，仅当前经办人作为签署人时生效

• （默认） false -否
• true - 展示签署按钮

发起过程中是否展示“保存草稿”按钮

1. 点击保存后，可以通过CreatePrepareFlow返回的DraftId保存草稿id
2. 可以用于二次发起合同： CreatePrepareFlow，ResourceType =3 //草稿

若指定了合同抄送人，此参数用来控制操作人能否在嵌入式页面看见或编辑（修改、增加、删除）抄送人信息。

枚举值：

• 0： 不可见不可编辑
• 1： 可见不可编辑
• 2： 可见可编辑

默认值：0

• 0 : 发起审批成功页面（通过接口创建发起流程web页面发起时设置了NeedCreateReview参数为true）

• 0（默认值）: 可以领取部分合同进入签署。
• 1 : 必须全部领取进入签署，生成链接的所有合同必须相同经办人完成合同的领取签署。

• true：允许在合同详情页展示控件
• false：（默认）不允许在合同详情页展示控件

• true :允许在模板预览页展示控件
• false :（默认）不允许在模板预览页展示控件

• （默认） false -否
• true - 禁止编辑

• （默认） false -否
• true - 禁止编辑

扩展服务的类型，可能是以下值：

• OPEN_SERVER_SIGN：企业“授权签”
• BATCH_SIGN：批量签署
• OVERSEA_SIGN：企业与港澳台居民签署合同
• AGE_LIMIT_EXPANSION：拓宽签署方年龄限制
• MOBILE_CHECK_APPROVER：个人签署方仅校验手机号
• HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名
• ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型
• ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方
• HIDE_ONE_KEY_SIGN：个人签署方手动签字
• PAGING_SEAL：骑缝章
• ORGANIZATION_FLOW_PASSWD_NOTIFY：签署密码开通引导

扩展服务的名称

扩展服务的开通状态：

• ENABLE : 已开通
• DISABLE : 未开通

操作扩展服务的操作人UserId，员工在腾讯电子签平台的唯一身份标识，为32位字符串。

扩展服务的操作时间，格式为Unix标准时间戳（秒）。

该扩展服务若可以授权，此参数对应授权人员的列表

• CREATE-客户上传图片创建
• GENERATE-系统模板印章生成
• SIST_SEAL-深圳电子印章

签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
模板发起合同时，该参数为必填项。
文件发起合同时，该参数无需传值。
如果开发者后序用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。

签署人来源
WEWORKAPP: 企业微信

仅【企微或签】时指定WEWORKAPP

企业微信UserId

当ApproverSource为WEWORKAPP的企微或签场景下，必须指企业自有应用获取企业微信的UserId

企业签署人的员工姓名。除企业微信应用场景（ApproverSource设置为WEWORKAPP）外，本字段为必填。

补充企业签署人员工手机号

• ApproverSource!=WEWORKAPP时，必传

补充企业动态签署人时，需要指定对应企业名称

签署方经办人的证件类型，支持以下类型

• ID_CARD 中国大陆居民身份证
• HONGKONG_AND_MACAO 中国港澳居民来往内地通行证
• HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)

注: 补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。

签署方经办人的证件号码，应符合以下规则

• 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
• 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字
• 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串

注：补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。

合同流程ID

• 补充合同组子合同动态签署人时必传。
• 补充普通合同时，请阅读：补充签署人接口的接口使用说明

通知类型：

签署时的相关信息

签署方姓名

签署方的签署状态
0：还没有发起
1：流程中 没有开始处理
2：待签署
3：已签署
4：已拒绝
5：已过期
6：已撤销
7：还没有预发起
8：待填写
9：因为各种原因而终止
10：填写完成
15：已解除
19：转他人处理

客户自定义的用户ID

签署人手机号

签署顺序，如果是有序签署，签署顺序从小到大

签署人签署时间，时间戳，单位秒

签署方类型，ORGANIZATION-企业员工，PERSON-个人，ENTERPRISESERVER-企业“授权签”

签署方侧用户来源，如WEWORKAPP-企业微信等

客户自定义签署方标识

签署方企业Id

签署方企业名称

签署参与人在本流程中的编号ID（每个流程不同），可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。

自定义签署人角色

模板配置中的参与方ID,与控件绑定

签署方转交记录列表，标识该签署方是由谁转交而来，按转交时间由远到近进行排序

• 0 : 未开启流程(合同中不存在填写环节)
• 1 : 待签署
• 2 : 部分签署
• 3 : 已拒签
• 4 : 已签署
• 5 : 已过期
• 6 : 已撤销
• 7 : 未开启流程(合同中存在填写环节)
• 8 : 等待填写
• 9 : 部分填写
• 10 : 已拒填
• 16 : 已失效（签署期间有签署人改名等原因导致）
• 21 : 已解除

在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：

• 0 :企业B端。
• 1 :个人C端。
• 3 :企业B端静默（自动）签署，无需签署人参与，“授权签”可以参考“授权签”使用说明文档。
• 7 :个人C端“授权签”，适用于个人“授权签”场景。注: 个人“授权签”场景为白名单功能，使用前请联系对接的客户经理沟通。

组织机构名称。请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。注: 当approverType=0(企业签署方) 或 approverType=3(企业“授权签”)时，必须指定

签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。

在未指定签署人电子签UserId情况下，为必填参数

签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。

注：在未指定签署人电子签UserId情况下，为必填参数

证件类型，支持以下类型

• ID_CARD: 居民身份证 (默认值)
• HONGKONG_AND_MACAO : 港澳居民来往内地通行证
• HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)

证件号码，应符合以下规则

• 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
• 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
• 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。

签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。

模板发起合同时，该参数为必填项，可以通过查询模板信息接口获得。
文件发起合同时，该参数无需传值。

如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。

签署意愿确认渠道，默认为WEIXINAPP:人脸识别

注: <font color="red">不再使用, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置

通知签署方经办人的方式, 有以下途径:

• SMS : (默认)短信
• EMAIL : 邮件
• ALL : 邮件+短信
• NONE : 不通知

注: 既是发起方又是签署方时，不给此签署方发送短信

枚举值：

• SMS： 短信通知
• EMAIL： 邮件通知
• ALL： 邮件通知+短信通知
• NONE： 不做任何形式的通知

合同强制需要阅读全文，无需传此参数

签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。

若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：

• 合同页数少于等于2页，阅读时间为3秒；
• 合同页数为3到5页，阅读时间为5秒；
• 合同页数大于等于6页，阅读时间为10秒。

签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得

注：
如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖）

字段不再使用，当前只支持true，默认为true

在企微场景下使用，需设置参数为WEWORKAPP，以表明合同来源于企微。

在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。
所有参与或签的人员均需具备该标识。
注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。
如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。

快速注册相关信息

签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。

签署人的签署ID

• 在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。
• 在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。

此签署人(员工或者个人)签署时，是否需要发起方企业审批，取值如下：

• false：（默认）不需要审批，直接签署。
• true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。

• 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
• 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。

签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效

合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体

• 个人签名/印章
• 企业印章
• 骑缝章等签署控件

此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主

签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效

合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

• 单行文本控件
• 多行文本控件
• 勾选框控件
• 数字控件
• 图片控件
• 动态表格等填写控件

此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主

当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：

• HANDWRITE :需要实时手写的手写签名。
• HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)
• OCR_ESIGN :AI智能识别手写签名。
• ESIGN :个人印章类型。
• IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。
• SYSTEM_ESIGN :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。

各种签名的样式可以参考下图：

指定个人签署方查看合同的校验方式,可以传值如下:

• 1 : （默认）人脸识别,人脸识别后才能合同内容
• 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）

• 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
• 此字段可传多个校验方式

此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主

.

您可以指定签署方签署合同的认证校验方式，可传递以下值：

• 1：人脸认证，需进行人脸识别成功后才能签署合同；
• 2：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；
• 3：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）
• 5：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）
• 6：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）

注：

• 默认情况下，认证校验方式为人脸认证和签署密码两种形式；
• 您可以传递多种值，表示可用多种认证校验方式。
• 校验方式不允许只包含设备指纹识别和设备面容识别，至少需要再增加一种其他校验方式。
• 设备指纹识别和设备面容识别只支持小程序使用，其他端暂不支持。

注:
此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主

生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：

• 0：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；
• 1：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。

签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署

注: 若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同

只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。

您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。

注意：

1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。
2. 使用视频认证时，生成H5签署链接必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。
3. 签署完成后，可以通过查询签署认证人脸视频获取到当时的视频。

进入签署流程的限制，目前支持以下选项：

• 空值（默认） :无限制，可在任何场景进入签署流程。
• link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。

是否不保存联系人
默认 false 保存联系人 true 不保存联系人

设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。
联系人查看可登录电子签控制台 进行查看。
如下图位置：

客户指定的邮箱信息

合同流程ID，为32位字符串。

合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

合同流程的类别分类（如销售合同/入职合同等）。
该字段将被废弃，不建议使用。

合同流程当前的签署状态, 会存在下列的状态值

• 0 : 未开启流程(合同中不存在填写环节)
• 1 : 待签署
• 2 : 部分签署
• 3 : 已拒签
• 4 : 已签署
• 5 : 已过期
• 6 : 已撤销
• 7 : 未开启流程(合同中存在填写环节)
• 8 : 等待填写
• 9 : 部分填写
• 10 : 已拒填
• 16 : 已失效（可能因为参与方修改姓名等原因）
• 21 : 已解除

当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。

合同流程描述信息。

合同流程的创建时间戳，格式为Unix标准时间戳（秒）。

合同流程的签署方数组

合同流程的关注方信息数组

合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。

用户合同的自定义分类。

自定义合同类型的位置，在下图所示地方:

发起模板时,使用的模板Id

合同备注列表

合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。

签署流程参与者信息，最大限制50方
注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。

文件资源ID，通过多文件上传UploadFiles接口获得，为32位字符串。
注：此字段定义为数组，但仅支持单个文件

合同模板ID，为32位字符串。
建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。

签署流程的类型(如销售合同/入职合同等)，最大长度200个字符

签署流程描述,最大长度1000个字符

签署流程的签署截止时间。

值为unix时间戳,精确到秒,不传默认为当前时间一年后
示例值：1604912664

调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。

发送类型：
true：无序签
false：有序签
注：默认为false（有序签），请和模板中的配置保持一致
示例值：true

模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体

• 单行文本控件
• 多行文本控件
• 勾选框控件
• 数字控件
• 图片控件
• 动态表格等填写控件

发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、“授权签”合同。示例值：true

个人“授权签”场景。发起“授权签”时，需设置对应“授权签”场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN

在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：

• 0 :合同（默认值）
• 1 :文件
• 2 :协议
• 3 :文书

抄送人信息

签署人校验方式,支持以下类型

• VerifyCheck : 人脸识别 (默认值)
• MobileCheck : 手机号验证

发起合同（流程）组本方企业经办人通知方式
签署通知类型，支持以下类型

• sms : 短信 (默认值)
• none : 不通知

发起合同（流程）组他方经办人通知方式
签署通知类型，支持以下类型

• sms : 短信 (默认值)
• none : 不通知

是否开启发起合同组的发起审批，默认：false(不开启)，开启后，发起合同组会提交电子签内置审批流

是否不可编辑合同名称 true-不可编辑 false-可编辑(默认)

是否不可编辑合同类型 true-不可编辑 false-可编辑(默认)

是否不可编辑合同截止日期 true-不可编辑 false-可编辑(默认)

签署控件配置(如是否默认展示日期)，用于嵌入式发起页面配置

是否禁止编辑水印控件属性 true-禁止 false-否(默认)

发起成功后是否隐藏签署码 true-隐藏 false-否(默认)

发起成功后是否签署合同,仅当前经办人为签署人时生效 true-展示签署 false-否(默认)

发起成功后是否预览合同 true-展示预览按钮 false-否(默认)

• false（默认值）: 合同流程完成签署后，支持发起对应的解除协议。
• true : 合同流程完成签署后，不支持发起对应的解除协议。

合同备注下标，对应最多5个备注位

取值范围：[0, 4]

合同备注内容，不超过 50 个字符，DELETE 时无需传入

• TEXT : 文本内容
• MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
• CHECK_BOX : true/false
• FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
• SELECTOR : 选项值
• DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
• DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）

转交人打码后的姓名

转交人打码后的手机号

进行转交的原因

枚举值：

• QUIT_FORWARD： 离职转交
• FORWARD： 员工操作转交

转交的详情信息

转交时间

单位：时间戳（秒级）

• 1：待授权
• 2：已授权待激活
• 3：拒绝授权
• 4：已解除
• 5：已加入

• true：是
• false：否

授权企业id

授权企业名称

被授权企业id

被授权企业名称

授权模板id（仅当授权方式为模板授权时有值）

授权模板名称（仅当授权方式为模板授权时有值）

授权时间，格式为时间戳，单位s

• 1 : 问答模式
• 2 : 点头模式

跳转事件枚举

枚举值：

• 1： 企业收录
• 2： 超管授权书审核
• 3： 企业认证完成

为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。
Endpoint如果是APP 类型，请传递"true"
如果 Endpoint 是 H5 类型，请参考文档跳转电子签H5

p.s. 如果Endpoint是 APP，传递的跳转地址无效，不会进行跳转，仅会进行回跳。

在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：

• 0 :企业B端。
• 1 :个人C端。
• 3 :企业B端静默（自动）签署，无需签署人参与，“授权签”可以参考“授权签”使用说明文档。
• 7 :个人C端“授权签”，适用于个人“授权签”场景。注: 个人“授权签”场景为白名单功能，使用前请联系对接的客户经理沟通。

组织机构名称。请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。注: 当approverType=0(企业签署方) 或 approverType=3(企业“授权签”)时，必须指定

签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。

在未指定签署人电子签UserId情况下，为必填参数

签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。

注：在未指定签署人电子签UserId情况下，为必填参数

证件类型，支持以下类型

• ID_CARD: 居民身份证 (默认值)
• HONGKONG_AND_MACAO : 港澳居民来往内地通行证
• HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)

证件号码，应符合以下规则

• 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
• 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
• 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。

签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。

模板发起合同时，该参数为必填项，可以通过查询模板信息接口获得。
文件发起合同时，该参数无需传值。

如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。

• 0 :合同（默认值）
• 1 :文件
• 2 :协议
• 3 :文书

• false：默认值，不禁止发起时修改合同内容
• true：禁止发起时修改合同内容（将直接跳过添加/编辑签署人步骤，直接到核对合同信息页面

签署方经办人的类型，支持以下类型

• ORGANIZATION 企业（含企业“授权签”）
• PERSON 个人（含个人“授权签”）

签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。

签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。

签署方经办人的证件类型，支持以下类型

• ID_CARD 中国大陆居民身份证 (默认值)
• HONGKONG_AND_MACAO 中国港澳居民来往内地通行证
• HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同居民身份证)

签署方经办人的证件号码，应符合以下规则

• 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
• 中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
• 中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。

组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。

• CloudEnterprise: 企业版合同
• SingleSignature: 单方签章
• CloudProve: 签署报告
• CloudOnlineSign: 腾讯会议在线签约
• ChannelWeCard: 微工卡
• SignFlow: 合同套餐
• SignFace: 签署意愿（人脸识别）
• SignPassword: 签署意愿（密码）
• SignSMS: 签署意愿（短信）
• PersonalEssAuth: 签署人实名（腾讯电子签认证）
• PersonalThirdAuth: 签署人实名（信任第三方认证）
• OrgEssAuth: 签署企业实名
• FlowNotify: 短信通知
• AuthService: 企业工商信息查询

• HIGH - 高风险


• NORMAL - 风险

验签结果。0-签名域未签名；1-验签成功； 3-验签失败；4-未找到签名域：文件内没有签名域；5-签名值格式不正确。

签署平台
如果文件是在腾讯电子签平台签署，则为腾讯电子签，
如果文件不在腾讯电子签平台签署，则为其他平台。

申请证书的主体的名字

如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
企业: ESS@企业名称@编码
个人: ESS@个人姓名@证件号@808854

如果在其他平台签署的, 主体的名字参考其他平台的说明

签署时间的Unix时间戳，单位毫秒

证书签名算法, 如SHA1withRSA等算法

在数字证书申请过程中，系统会自动生成一个独一无二的序列号。

证书起始时间的Unix时间戳，单位毫秒

证书过期时间的时间戳，单位毫秒

签名域横坐标，单位px

签名域纵坐标，单位px

签名域宽度，单位px

签名域高度，单位px

签名域所在页码，1～N

证书颁发机构

是否有可信时间戳

预设参与方姓名。

预设参与方手机号。

预设参与方证件号，需要和IdCardType同时传入。

证件号码，应符合以下规则

• 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。

预设参与方的证件类型，需要与IdCardNumber同时传入。

证件类型，支持以下类型

• ID_CARD: 居民身份证

企业用户动态签署方场景指定预设企业名称。

注意：1. 若为企业动态签署方场景，此参数必须要指定。2. 企业动态签署方场景暂不支持指定姓名证件手机号等参数，仅支持指定企业名称。

• 1 :实名认证查看
• 2 :手机号校验查看

• 1 :人脸认证
• 2 :签署密码
• 3 :运营商三要素认证
• 4 :UKey认证
• 5 :设备指纹识别
• 6 :设备面容识别

• false : ( 默认)可以转他人处理
• true :不可以转他人处理

签署方经办人在合同流程中的参与方ID，与控件绑定，是控件的归属方

参与方填写状态

• 空值 : 此参与方没有填写控件
• 0: 未填写, 表示此参与方还没有填写合同的填写控件
• 1: 已填写, 表示此参与方已经填写所有的填写控件

是否为发起方