防号 （预览版）

使用防单符号自动执行 PDF 和 DOCX 文档的安全电子签名工作流。 组织可以创建单文档或多文档签名请求、分配收件人和签名角色、跟踪状态、下载已完成的 PDF 和删除文档。 需要一个防震签名帐户、支持所选操作和签名类型的计划，以及有效的 API 令牌。

此连接器在以下产品和区域中可用：

Service	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有 逻辑应用区域 ：      - Azure 政府区域      - Azure 中国区域      - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）

联系人
Name	API 支持
URL	https://sproof.com
Email	support@sproof.com

连接器元数据
Publisher	防 sproof GmbH
网站	https://www.sproof.com/en/sign/
隐私策略	https://www.sproof.com/en/privacy-policy-app/
Categories	生产力;内容和文件

防号

概述

防符号使组织能够自动执行 PDF 和 DOCX 文档的电子签名工作流。 连接器可以创建单文档签名请求或多文档信封、分配收件人和签名角色、检索请求状态、下载已完成的文档和删除文档。

先决条件

若要使用连接器，需要：

• 一个防震签名帐户。
• 具有 API 访问权限和支持所需操作和签名类型的防弹签名计划。
• 有效的防震签名 API 令牌。

Authentication

连接器使用 API 令牌身份验证。 通过输入与帐户关联的有效防号 API 令牌来创建连接。 确保令牌安全，并在令牌被吊销或重新生成时将其替换。

支持的操作

• 创建签名请求 - 为一个文档或包含多个文档的信封创建请求。 可以配置收件人、签名角色、签名顺序、签名位置和其他邀请设置。
• 使用占位符创建签名请求 — 使用上传的文档中存储的占位符创建请求。 从这些占位符中提取收件人信息和签名位置。
• 获取请求状态 - 使用其成员 ID 检索签名请求的当前状态和签名状态。
• 获取文档 - 以二进制 PDF 或 Base64 编码的 PDF 形式下载文档。
• 删除文档 - 根据提供的成员 ID、成员的角色以及文档是否属于信封，删除文档或删除成员的访问权限。

已知限制和要求

• 输入文档必须作为 Base64 编码的 PDF 或 DOCX 内容提供。
• 信封最多可以包含 25 个文档。
• 提交多个文档时，需要信封名称。
• 基于占位符的请求需要在上传的文档中正确设置格式的占位符。
• 对于基于占位符的请求，收件人和签名位置是从文档获取的，而不是手动输入的。
• 可用的操作、签名类型和提供程序取决于连接的防签名帐户和计划。
• 文档删除行为取决于提供的成员 ID 是否属于发件人或收件人，以及文档是否是信封的一部分。

Support

有关连接器或 API 支持人员，请联系 support@sproof.com。

正在创建连接

连接器支持以下身份验证类型：

默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必需
代币	安全字符串	“token” für diese API	是

操作

使用占位符创建签名请求	使用存储在已上传文档中的占位符创建签名请求。 收件人和签名位置是从文档中提取的。
创建签名请求	这是新的创建签名请求。 除了创建单个文档邀请之外，它还支持在发送邀请时一次性创建信封和上传多个文档。
删除文档	删除文档或删除成员对文档的访问权限，具体取决于提供的 memberId 是否属于发件人或收件人，以及文档是否属于信封。 信封中的文档 查询参数 all 对信封中的文档无效。 使用发件人 memberId： 为发件人和所有收件人删除单个文档。 文档将从信封中删除。 memberId收件人： 信封中的所有文档都将删除收件人。 收件人被标记为 declined 已为收件人删除的所有文档。 文档仍可供文档上的所有其他成员使用。 单个文档 使用发件人 memberId 和 all=true： 将删除发件人和所有收件人的文档。 使用发件人 memberId 和 all=false： 仅对发件人删除该文档。 该文档仍可供文档上的其他收件人使用。 memberId收件人： 收件人被标记为 declined 文档中。 该文档仍可供文档上的所有其他成员使用。
获取文档	以二进制或 Base64 编码的字符串形式获取已签名的文档。
获取请求状态	获取签名请求的状态。 返回文档 JSON 对象或错误。 参数由文档中的 post 请求返回，并与发件人电子邮件相关联。

使用占位符创建签名请求

操作 ID:

CreateSignatureRequestUsingPlaceholders

使用存储在已上传文档中的占位符创建签名请求。 收件人和签名位置是从文档中提取的。

参数

名称	密钥	必需	类型	说明
电子邮件	email	True	string	发件人的电子邮件。 它必须属于计划的成员。
firstName	firstName	True	string	发件人的名字。
lastName	lastName		string	发件人的姓氏。
角色	role		string	发件人对所有文档的角色。
电子邮件	email		string	收件人的电子邮件。
firstName	firstName		string	收件人的名字。
lastName	lastName		string	收件人的姓氏。
doNotSendEmails	doNotSendEmails		boolean	如果设置为 true “未向收件人发送电子邮件”。
customId	customId		string	仅在邀请时收件人的电子邮件地址 未知 时才使用。 仅当邀请收件人（不用于准备路由）并且想要使用 fastlane 时，这才有效。 这样 customId ，就可以在发送邀请之前为收件人预生成唯一的签名链接。 必须是至少 70 个字符的唯一字母数字字符串。 注意：customId 只能用于生成指向文档的收件人链接。 它不能用于其他请求而不是 memberId。 有关 URL 构造的详细信息，请参阅 使用自定义 ID 打开文档
useFastlane	useFastlane		boolean	如果设置为 true 签名者在邀请电子邮件中收到 Fastlane 链接。
phoneNumber	phoneNumber		string	此收件人的电话号码。 这用于短信验证。 （例如：+43 699 1234 1234）。
privateMessage	privateMessage		string	此特定收件人的专用邮件。
inPersonMode	inPersonMode		boolean	启用此选项后，需要签名请求的收件人才能亲自对文档进行签名，并且不会发送电子邮件。 此模式仅适用于使用 SES 签名类型
signatureTypes	signatureTypes		array of string	此收件人允许的签名类型。 选项：['advanced'、'advancedPlus'、'qualified'、'qualifiedPlusIdent'、'simple']
标签	tag		string	此标记确定将用于签名过程的标识提供者。 从预定义的受支持提供程序集中进行选择。 注意1： 某些提供程序仅适用于某些 signatureType，例如 onetimeqes 需要 "signatureType" : ["qualifiedPlusIdent"] 注意2： 使用 sproof-qualified 作为默认提供程序时，收件人必须具有具有活动用户+ 许可证的活动防空帐户。
canChange	canChange		boolean	指示受邀收件人是否应能够更改签名提供程序的布尔值
国家	country		string	默认国家/地区（如果为空）设置为“全部”，则会返回错误，其中所选提供商标记的国家/地区可用
截止日期	dueDate		YYYY-MM-DD	文档可签名的日期。 此截止日期显示在邀请电子邮件中的收件人，并且也会显示在仪表板的文档详细信息部分中。 它充当完成签名过程的最后期限。
reminderInterval	reminderInterval		number	指定提醒电子邮件之间的天数。
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	应从中发送提醒的日期
inviteLanguage	inviteLanguage		string	指定发送给没有帐户的匿名用户的电子邮件的语言。 对于具有帐户的用户，将使用他们在个人资料中选择的语言。
消息	message		string	电子邮件中发送给收件人的自定义邮件。
subject	subject		string	发送给收件人的电子邮件的主题行。
sendOutFinishedPdf	sendOutFinishedPdf		boolean	如果设置为 true，则 pdf 作为附件发送到文档上的所有收件人（如果小于 5MB）。
focusedSigningMode	focusedSigningMode		boolean	启用此选项后，签名请求的收件人将仅限于对文档进行签名或拒绝，并且无法从页面导航。
allowForwarding	allowForwarding		boolean	允许转发邀请。
collabSigningMode	collabSigningMode		object	一个对象，其中每个键表示一个签名轮，其相应的值指示是否为该轮启用协作签名。 如果值为 true，则只需一个签名即可完成指定的签名回合，然后继续执行下一轮。 例如，{ “1”： true } 表示在签名第 1 轮中，只需要一个签名。
inPersonSigning	inPersonSigning		boolean	如果为 true，收件人将收到一个弹出窗口，其中他需要手动绘制签名
folderName	folderName		string	如果给定，则会创建一个信封，其中包含 documentDataArray 中的所有文档。 （如果发送了多个文档，则需要）
回调网址	callbackUrl		string	创建新签名或收件人拒绝文档时，POST 请求（包括文档）将发送到此 URL。 如果失败，则执行重试机制以确保重试请求。
returnUrl	returnUrl		string	签署文档后返回按钮的链接
returnBtnText	returnBtnText		string	签署文档后返回按钮的文本
数据	data	True	string	以 base64 格式的文档（PDF 或 DOCX）数据。
mimetype	mimetype		string	如果文档不是 pdf，则需要 base64 编码数据 PDF 或 DOCX 的 MIME 类型
fileName	fileName	True	string	文件的名称
标签	label		string	可以发送到组织文档的自定义标签。
页面	page	True	integer	框打开的页数，第一页为 0。
pageWidth	pageWidth		integer	描述页面宽度的任何整数值。 数字越大，在 x y 空间中定位框时精度越好。 在 A4 页上，我们具有 478 作为默认值。
pageHeight	pageHeight		integer	描述页面高度的任何整数值。 数字越大，在 x y 空间中定位框时精度越好。 在 A4 页上，我们有 676 个默认值。
x	x	True	float	表示框的水平位置作为页面宽度的百分比。 原点 （0,0） 位于页面的左上角。 值为 0.1 表示框位于页面宽度的 10%（从左侧）。
y	y	True	float	将框的垂直位置表示为页面高度的百分比。 原点 （0,0） 位于页面的左上角。 值为 0.1 表示框位于页面高度的 10%（从顶部）。
width	width	True	float	基于页面尺寸的框宽度，类似于 x 和 y 坐标。 它是表示 pageWidth 百分比的浮点数。
身高	height	True	float	基于页面尺寸的框的高度，类似于 x 和 y 坐标。 它是表示 pageHeight 百分比的浮点数。
id	id	True	string	此框的唯一 ID，以所需的任何方式生成。
标签	label		string	占位符文本，例如字段的名称，例如“出生日期”。。
value	value		string	框的默认值。 可以为 null。 如果该框的类型为“chooseBox”，则该值可以为 null 或选项中定义的字符串之一。
readonly	readonly		boolean	如果设置为 true，则受邀人员无法修改此框的值。
required	required		boolean	如果设置为 true，则受邀人员无法在未填写此框的情况下对文档进行签名。
类型	type	True	string
多行	multiline		boolean	是否允许多行。
displayValue	displayValue	True	string
exportValue	exportValue	True	string
组	group		number	可将每个无线电盒分配给一个组。
signatureTypes	signatureTypes		array of string	此收件人允许的签名类型可由收件人签名类型覆盖。 选项：['advanced'、'advancedPlus'、'qualified'、'simple'、'qualifiedPlusIdent']
refId	refId		string	refId 是用于交叉引用已上传文档的可选字段。 如果提供，则允许向文档分配自定义引用标识符，该标识符将在将来的 API 响应中作为文档对象的一部分返回。 这对于通过外部系统或工作流跟踪或组织文档非常有用。
语言	language		string	文档语言。
folderId	folderId		string	应在其中插入文档的文件夹的 ID。 仅当 undefined inviteData 和 folderName 时，才可能执行此操作。
isAttachment	isAttachment		boolean	在这种情况下，不需要 isAttachment。
useFastlane	useFastlane		boolean	如果设置为 true 签名者在邀请电子邮件中收到 Fastlane 链接。
fastlaneProfileId	fastlaneProfileId		uuid	指定应用于本文档的 Fastlane 配置文件。 （useFastlane 必须设置为 true）。

返回

Body

EnvelopeResponse

创建签名请求

操作 ID:

CreateSignatureRequest

这是新的创建签名请求。 除了创建单个文档邀请之外，它还支持在发送邀请时一次性创建信封和上传多个文档。

参数

名称	密钥	必需	类型	说明
电子邮件	email	True	string	发件人的电子邮件。 它必须属于计划的成员。
firstName	firstName	True	string	发件人的名字。
lastName	lastName		string	发件人的姓氏。
角色	role		string	发件人对所有文档的角色。
电子邮件	email		string	收件人的电子邮件。
firstName	firstName		string	收件人的名字。
lastName	lastName		string	收件人的姓氏。
doNotSendEmails	doNotSendEmails		boolean	如果设置为 true “未向收件人发送电子邮件”。
customId	customId		string	仅在邀请时收件人的电子邮件地址 未知 时才使用。 仅当邀请收件人（不用于准备路由）并且想要使用 fastlane 时，这才有效。 这样 customId ，就可以在发送邀请之前为收件人预生成唯一的签名链接。 必须是至少 70 个字符的唯一字母数字字符串。 注意：customId 只能用于生成指向文档的收件人链接。 它不能用于其他请求而不是 memberId。 有关 URL 构造的详细信息，请参阅 使用自定义 ID 打开文档
useFastlane	useFastlane		boolean	如果设置为 true 签名者在邀请电子邮件中收到 Fastlane 链接。
phoneNumber	phoneNumber		string	此收件人的电话号码。 这用于短信验证。 （例如：+43 699 1234 1234）。
privateMessage	privateMessage		string	此特定收件人的专用邮件。
inPersonMode	inPersonMode		boolean	启用此选项后，需要签名请求的收件人才能亲自对文档进行签名，并且不会发送电子邮件。 此模式仅适用于使用 SES 签名类型
signatureTypes	signatureTypes		array of string	此收件人允许的签名类型。 选项：['advanced'、'advancedPlus'、'qualified'、'qualifiedPlusIdent'、'simple']
标签	tag		string	此标记确定将用于签名过程的标识提供者。 从预定义的受支持提供程序集中进行选择。 注意1： 某些提供程序仅适用于某些 signatureType，例如 onetimeqes 需要 "signatureType" : ["qualifiedPlusIdent"] 注意2： 使用 sproof-qualified 作为默认提供程序时，收件人必须具有具有活动用户+ 许可证的活动防空帐户。
canChange	canChange		boolean	指示受邀收件人是否应能够更改签名提供程序的布尔值
国家	country		string	默认国家/地区（如果为空）设置为“全部”，则会返回错误，其中所选提供商标记的国家/地区可用
截止日期	dueDate		YYYY-MM-DD	文档可签名的日期。 此截止日期显示在邀请电子邮件中的收件人，并且也会显示在仪表板的文档详细信息部分中。 它充当完成签名过程的最后期限。
reminderInterval	reminderInterval		number	指定提醒电子邮件之间的天数。
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	应从中发送提醒的日期
inviteLanguage	inviteLanguage		string	指定发送给没有帐户的匿名用户的电子邮件的语言。 对于具有帐户的用户，将使用他们在个人资料中选择的语言。
消息	message		string	电子邮件中发送给收件人的自定义邮件。
subject	subject		string	发送给收件人的电子邮件的主题行。
sendOutFinishedPdf	sendOutFinishedPdf		boolean	如果设置为 true，则 pdf 作为附件发送到文档上的所有收件人（如果小于 5MB）。
focusedSigningMode	focusedSigningMode		boolean	启用此选项后，签名请求的收件人将仅限于对文档进行签名或拒绝，并且无法从页面导航。
allowForwarding	allowForwarding		boolean	允许转发邀请。
collabSigningMode	collabSigningMode		object	一个对象，其中每个键表示一个签名轮，其相应的值指示是否为该轮启用协作签名。 如果值为 true，则只需一个签名即可完成指定的签名回合，然后继续执行下一轮。 例如，{ “1”： true } 表示在签名第 1 轮中，只需要一个签名。
usePlaceholders	usePlaceholders		boolean	如果为 true，则文档中存储的文本占位符/formFields 将用于邀请收件人。
inPersonSigning	inPersonSigning		boolean	如果为 true，收件人将收到一个弹出窗口，其中他需要手动绘制签名
folderName	folderName		string	如果给定，则会创建一个信封，其中包含 documentDataArray 中的所有文档。 （如果发送了多个文档，则需要）
回调网址	callbackUrl		string	创建新签名或收件人拒绝文档时，POST 请求（包括文档）将发送到此 URL。 如果失败，则执行重试机制以确保重试请求。
returnUrl	returnUrl		string	签署文档后返回按钮的链接
returnBtnText	returnBtnText		string	签署文档后返回按钮的文本
数据	data	True	string	以 base64 格式的文档（PDF 或 DOCX）数据。
mimetype	mimetype		string	如果文档不是 pdf，则需要 base64 编码数据 PDF 或 DOCX 的 MIME 类型
fileName	fileName	True	string	文件的名称
标签	label		string	可以发送到组织文档的自定义标签。
页面	page	True	integer	框打开的页数，第一页为 0。
pageWidth	pageWidth		integer	描述页面宽度的任何整数值。 数字越大，在 x y 空间中定位框时精度越好。 在 A4 页上，我们具有 478 作为默认值。
pageHeight	pageHeight		integer	描述页面高度的任何整数值。 数字越大，在 x y 空间中定位框时精度越好。 在 A4 页上，我们有 676 个默认值。
x	x	True	float	表示框的水平位置作为页面宽度的百分比。 原点 （0,0） 位于页面的左上角。 值为 0.1 表示框位于页面宽度的 10%（从左侧）。
y	y	True	float	将框的垂直位置表示为页面高度的百分比。 原点 （0,0） 位于页面的左上角。 值为 0.1 表示框位于页面高度的 10%（从顶部）。
width	width	True	float	基于页面尺寸的框宽度，类似于 x 和 y 坐标。 它是表示 pageWidth 百分比的浮点数。
身高	height	True	float	基于页面尺寸的框的高度，类似于 x 和 y 坐标。 它是表示 pageHeight 百分比的浮点数。
id	id	True	string	此框的唯一 ID，以所需的任何方式生成。
标签	label		string	占位符文本，例如字段的名称，例如“出生日期”。。
value	value		string	框的默认值。 可以为 null。 如果该框的类型为“chooseBox”，则该值可以为 null 或选项中定义的字符串之一。
readonly	readonly		boolean	如果设置为 true，则受邀人员无法修改此框的值。
required	required		boolean	如果设置为 true，则受邀人员无法在未填写此框的情况下对文档进行签名。
类型	type	True	string
多行	multiline		boolean	是否允许多行。
displayValue	displayValue	True	string
exportValue	exportValue	True	string
组	group		number	可将每个无线电盒分配给一个组。
signatureTypes	signatureTypes		array of string	此收件人允许的签名类型可由收件人签名类型覆盖。 选项：['advanced'、'advancedPlus'、'qualified'、'simple'、'qualifiedPlusIdent']
refId	refId		string	refId 是用于交叉引用已上传文档的可选字段。 如果提供，则允许向文档分配自定义引用标识符，该标识符将在将来的 API 响应中作为文档对象的一部分返回。 这对于通过外部系统或工作流跟踪或组织文档非常有用。
语言	language		string	文档语言。
folderId	folderId		string	应在其中插入文档的文件夹的 ID。 仅当 undefined inviteData 和 folderName 时，才可能执行此操作。
isAttachment	isAttachment		boolean	在这种情况下，不需要 isAttachment。
收件人详细信息	recipientDetails	True	object	收件人详细信息由收件人电子邮件进行键键。 示例： {“”mail@test.com：{“role”：“signer”，“signaturePositions”：[{“page”：0，“x”：0.55，“y”：0.80，“width”：0.25，“height”：0.08}]}}。
useFastlane	useFastlane		boolean	如果设置为 true 签名者在邀请电子邮件中收到 Fastlane 链接。
fastlaneProfileId	fastlaneProfileId		uuid	指定应用于本文档的 Fastlane 配置文件。 （useFastlane 必须设置为 true）。

返回

Body

EnvelopeResponse

删除文档

操作 ID:

DeleteDocument

删除文档或删除成员对文档的访问权限，具体取决于提供的 memberId 是否属于发件人或收件人，以及文档是否属于信封。

信封中的文档

查询参数 all 对信封中的文档无效。

使用发件人 memberId：

• 为发件人和所有收件人删除单个文档。
• 文档将从信封中删除。

memberId收件人：

• 信封中的所有文档都将删除收件人。
• 收件人被标记为 declined 已为收件人删除的所有文档。
• 文档仍可供文档上的所有其他成员使用。

单个文档

使用发件人 memberId 和 all=true：

• 将删除发件人和所有收件人的文档。

使用发件人 memberId 和 all=false：

• 仅对发件人删除该文档。
• 该文档仍可供文档上的其他收件人使用。

memberId收件人：

• 收件人被标记为 declined 文档中。
• 该文档仍可供文档上的所有其他成员使用。

参数

名称	密钥	必需	类型	说明
成员 ID	memberId	True	string	成员 ID
删除所有收件人	all		boolean	仅当所提供的 memberId 文档属于发件人时，才与单个文档相关。 如果设置为该文档 true，则会删除发件人和所有收件人的文档。 如果设置为 false，则仅删除发件人的文档，并且仍可供其他收件人使用。 此参数对信封（default = true） 中的文档无效，或者当所提供的 memberId 文档属于收件人时。

返回

响应

DeleteDocumentResponse

获取文档

操作 ID:

GetDocument

以二进制或 Base64 编码的字符串形式获取已签名的文档。

参数

名称	密钥	必需	类型	说明
成员 ID	memberId	True	string	成员 ID
下载格式	format		string	指定响应格式。 用于 pdf 二进制 PDF 和 base64 Base64 编码的响应。 示例 base64 响应： json { "base64": "JVBERi0xLjQKJe..." }

返回

名称	路径	类型	说明
base64	base64	string	Base64 编码的 PDF 内容

获取请求状态

操作 ID:

GetSignatureStatus

获取签名请求的状态。 返回文档 JSON 对象或错误。 参数由文档中的 post 请求返回，并与发件人电子邮件相关联。

参数

名称	密钥	必需	类型	说明
成员 ID	memberId	True	string	成员 ID

返回

Body

DocumentStatusForFlow

定义

DeleteDocumentResponse

删除文档响应

string

EnvelopeResponse

名称	路径	类型	说明
folderId	folderId	string
folderName	folderName	string
文档	documents	array of object
id	documents.id	string
名字	documents.name	string
语言	documents.language	string
startSendingReminders	documents.startSendingReminders	date-time	开始发送提醒的日期和时间（ISO 8601 日期/时间字符串）
sendReminder	documents.sendReminder	boolean
reminderSent	documents.reminderSent	boolean
reminderInterval	documents.reminderInterval	number
createdAt	documents.createdAt	date-time	创建文档的日期和时间（ISO 8601 日期/时间字符串）
回调网址	documents.callbackUrl	string
returnUrl	documents.returnUrl	string
returnBtnText	documents.returnBtnText	string
inPersonSigning	documents.inPersonSigning	boolean
signingRound	documents.signingRound	number
isTemplate	documents.isTemplate	boolean
templateId	documents.templateId	string
linkId	documents.linkId	string
linkExpiresAt	documents.linkExpiresAt	string
derivedFromLink	documents.derivedFromLink	boolean
状态	documents.state	string
complianceLevel	documents.complianceLevel	string
allowForwarding	documents.allowForwarding	boolean
linkExpires	documents.linkExpires	boolean
setDueDate	documents.setDueDate	boolean
截止日期	documents.dueDate	date-time	文档的截止日期（ISO 8601 日期/时间字符串）
focusedSigningMode	documents.focusedSigningMode	boolean
linkMaxSignaturesEnabled	documents.linkMaxSignaturesEnabled	boolean
linkMaxSignatures	documents.linkMaxSignatures	number
fastlaneProfileId	documents.fastlaneProfileId	string
refId	documents.refId	string
sendOutFinishedPdf	documents.sendOutFinishedPdf	boolean
signatureTypes	documents.signatureTypes	array of string
members	documents.members	array of MemberResponseSchema
成员	documents.member	MemberResponseSchema
盒	documents.boxes	array of DocumentResponseBox	文档响应中的窗体字段框。 仅当文档具有窗体字段时，才会返回此字段。 如果文档已签名，文档将返回包含已填写值的框。
过期	documents.overdue	boolean

DocumentResponseBox

名称	路径	类型	说明
id	id	string
类型	type	string
value	value	string	框字段的值。 可以是字符串（包括空字符串）、布尔值或 null，具体取决于框类型。
标签	label	string

MemberResponseSchema

名称	路径	类型	说明
id	id	string
documentId	documentId	string
电子邮件	email	string
firstName	firstName	string
lastName	lastName	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time	创建成员的日期和时间（ISO 8601 日期/时间字符串）
sentDeleteNotificationAt	sentDeleteNotificationAt	date-time	发送删除通知的日期和时间（ISO 8601 日期/时间字符串）
manuallyLastEmailSent	manuallyLastEmailSent	date-time	发送上次手动电子邮件的日期和时间（ISO 8601 日期/时间字符串）
signaturePosition	signaturePosition	MemberSignaturePositionResponse	具有其他响应特定字段的签名位置数据。 cardStyle、pageWidth 和 pageHeight 字段是可选的，可能不存在于所有 API 响应中。
doNotSendEmails	doNotSendEmails	boolean
declinedAt	declinedAt	date-time	成员拒绝的日期和时间（ISO 8601 日期/时间字符串）
signingOrder	signingOrder	number
onDemand	onDemand	string
recipientId	recipientId	string
signatureTypes	signatureTypes	array of string
signatureTypesActive	signatureTypesActive	boolean
privateMessage	privateMessage	string
customId	customId	string
useFastlane	useFastlane	boolean
角色	role	string
approvedAt	approvedAt	date-time	批准成员的日期和时间（ISO 8601 日期/时间字符串）
verificationConfig	verificationConfig
phoneNumber	phoneNumber	string
签名	signatures	array of string
signedAt	signedAt	date-time	成员签名的日期和时间（ISO 8601 日期/时间字符串）

MemberSignaturePositionResponse

具有其他响应特定字段的签名位置数据。 cardStyle、pageWidth 和 pageHeight 字段是可选的，可能不存在于所有 API 响应中。

名称	路径	类型	说明
物品		SignaturePositionResponse	具有其他响应特定字段的签名位置数据。 cardStyle、pageWidth 和 pageHeight 字段是可选的，可能不存在于所有 API 响应中。

SignaturePositionResponse

具有其他响应特定字段的签名位置数据。 cardStyle、pageWidth 和 pageHeight 字段是可选的，可能不存在于所有 API 响应中。

名称	路径	类型	说明
页面	page	integer	页码，从 0 开始。
x	x	number	签名左上角位置的 x 坐标
y	y	number	签名左上角位置的 y 坐标
width	width	number	签名的宽度。
身高	height	number	签名的高度。
cardStyle	cardStyle	string	签名卡的视觉样式。 此字段是可选的，可能不会在所有响应中返回。
pageWidth	pageWidth	number	页面的宽度（以像素为单位）。 此字段是可选的，可能不会在所有响应中返回。
pageHeight	pageHeight	number	页面的高度（以像素为单位）。 此字段是可选的，可能不会在所有响应中返回。

DocumentStatusForFlow

名称	路径	类型	说明
id	id	string
名字	name	string
状态	state	string	文档的当前状态。 可能的值包括：草稿、挂起、拒绝、已完成、附件、手动Pending、手动完成
createdAt	createdAt	date
updatedAt	updatedAt	date
allSignersSigned	allSignersSigned	boolean
allMembersSigned	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean