通过

Verified

用于验证 API 的连接器，用于启用自定义文档签名过程的创建。

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

服务 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 Verified
URL https://verified.eu/en/#about-us
Email support@verified.eu
连接器元数据
发布者 Crm - Konsulterna i Sverige AB
网站 https://verified.eu/
隐私策略 https://verified.eu/trust-center
类别 内容和文件;生产力

验证是作为电子标识和数字签名服务提供商的软件。 通过此连接器，可以集成到已验证 API，并在应用程序中创建简单直观的签名过程。

先决条件

需要满足以下条件才能继续作：

如何获取凭据

此连接器使用基本身份验证。 创建连接时，用户必须提供用户名、密码和公司 ID。 用户名和密码与用于登录到已验证门户的用户名和密码相同。 若要获取必须登录到已验证门户的公司 ID，如果有多个公司并从 URL 复制公司 ID，请选择正确的公司。

开始

常见的用例是启动和管理签名过程，即设置自动化，以便将文档发送到已验证并定期重新获取已签名文档。 用于启动已验证签名过程的常见作包括创建信封 - 描述符或创建信封 - 默认值、向信封添加文档、向文档添加文件、向信封添加收件人和更新信封的发布状态。 用于检查文档的已验证状态的常见作包括按 ID 获取信封、按信封 ID 获取所有文档、按文档 ID 获取文件、按 ID 获取文件 URL。请注意，生成安全令牌的作始终用作第一步，以便获取在以下步骤中使用的安全令牌。

已知问题和限制

目前已知以下限制。

  • 在每个流开始时，必须创建一个身份验证令牌，以在后续步骤中重复使用。
  • 若要添加文档，必须向特定 URL 发送 HTTP 请求。
  • 若要使用新的搜索终结点，必须通过验证的 Suppoert 为帐户激活该终结点。

FAQ

如何将文档上传到已验证？

若要上传实际文档，必须在已验证 API 中创建文件，并将文档哈希上传到从已验证 API 响应的 Blob URL。

使用“获取信封 ID”作后，如何获取信封的保留？

创建信封的步骤使用 uid 进行响应，这是信封的完整路径（例如：“/envelopes/ABCDE”）。 对于其他步骤，只需 uid 的最后一部分（即实际信封 ID，在我们的示例中为“ABCDE”）。

下面是有关如何执行此作的示例

substring(outputs('Create_new_default_envelope')?['body/uid'],11)

使用“向信封添加文档”作后，如何获取文档 ID 的保留？

创建文档的步骤使用页眉中新文档的位置做出响应。 位置是文档的完整路径（例如：“/api/envelopes/ABCDE/documents/FGHIJ”）。 以下步骤仅需要文档 ID（在本例中为 FGHIJ）。

下面是有关如何执行此作的示例

substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))

如何从信封获取流 ID？

当加载有关信封的信息时，相关流将是响应的一部分（例如：“/flow/default”）。 在响应中，它被称为流的 ID，但是当另一个步骤（如获取流状态）请求流 ID 时，只有最后一部分。

下面是有关如何执行此作的示例

substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)

如何使用新的搜索作？

若要能够使用新的搜索作，必须为已验证的组织激活搜索终结点。 为此，必须向已验证的支持人员（包括组织 ID）发送电子邮件，以便他们可以为你激活终结点。

正在创建连接

连接器支持以下身份验证类型：
默认 用于创建连接的参数。 所有区域 不可共享

违约

适用：所有区域

用于创建连接的参数。

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

Name 类型 Description 必选
用户名 securestring 此 API 的用户名 True
密码 securestring 此 API 的密码 True
公司 ID 字符串 公司 ID 由已验证提供。 可以通过登录到 app.verified.eu 在 URL 中找到 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

从模板生成文档

从预配置的模板生成文档。
创建信封 - 描述符

基于特定描述符创建信封。
创建信封 - 默认值

使用默认描述符创建新信封。
创建签名链接

创建签名链接。 实现特定于流，并且特定流可能缺失。
发送通知

向给定信封的重新定位发送通知。
将收件人添加到信封

将收件人添加到给定信封。
将文件添加到文档

将文件添加到现有文档。
将文档添加到信封

将新文档添加到现有信封。
按 ID 删除信封

删除给定信封。
按 ID 删除文档

删除给定文档。
按 ID 更新收件人

更新收件人。
按 ID 获取信封

获取给定信封的详细信息。
按 ID 获取公司

获取给定公司的信息。
按 ID 获取描述符

获取给定描述符的信息。
按 ID 获取文件

获取有关给定文件的信息。
按 ID 获取文件 URL

获取给定文件的 URL。
按 ID 获取文档

获取给定文档的信息。
按信封 ID 获取所有文档

获取与给定信封相关的所有文档。
按信封 ID 获取流状态

获取给定信封的当前流状态。
按文档 ID 获取文件

获取连接到给定文档的所有文件。
搜索所有信封

搜索与给定筛选器匹配的所有信封。
更新信封的发布状态

更新给定信封的发布状态。
更新信封设置

更新给定信封的设置。
查询所有信封（已弃用）

查询与给定筛选器匹配的所有信封。 （已弃用）
生成安全令牌

从已验证的 API 获取身份验证令牌。
获取信封的特定收件人

获取给定信封的特定收件人。
获取所有信封收件人

获取给定信封的所有收件人。
获取所有描述符

获取当前公司中存在的所有描述符的列表。 可以筛选列表。
获取用户信息

获取当前登录用户的信息。
获取用户设置

获取给定用户的设置。
获取默认描述符

获取信封的默认描述符。
设置信封中止状态

将给定信封的状态设置为已中止。
设置信封回收站状态

将给定信封的状态设置为已回收。
设置文档中止状态

将给定文档的状态设置为已中止。

从模板生成文档

操作 ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdTemplatesTemplateIdUserData

从预配置的模板生成文档。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
文档 ID
 document-id True string

有问题的文档的 ID
模板 ID
 template-id True string

应使用的模板的 ID
object

创建信封 - 描述符

操作 ID:
PostEnvelopeDescriptorsEnvelopeDescriptorIdEnvelopes

基于特定描述符创建信封。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封描述符 ID
 envelope-descriptor-id True string

信封描述符的 ID
Email
 email string
名字
 givenName string
姓氏
 familyName string
自动提醒
 automaticReminders number
过期日期
 expiration string
Hash
 hash string

返回

名称 路径 类型 说明
uid
 uid string

创建信封 - 默认值

操作 ID:
PostEnvelopeDescriptorsDefaultEnvelopes

使用默认描述符创建新信封。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
Email
 email string
名字
 givenName string
姓氏
 familyName string
自动提醒
 automaticReminders number
过期日期
 expiration string
Hash
 hash string

返回

名称 路径 类型 说明
uid
 uid string

创建签名链接

操作 ID:
PostEnvelopesEnvelopeIdJobsGetSignLink

创建签名链接。 实现特定于流，并且特定流可能缺失。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
Id
 id string
重定向到
 redirectTo uri

用于在登录后将用户重定向到的完整 URL。

返回

名称 路径 类型 说明
URL
 getSignLink.recipient.{recipient-id}.url string

发送通知

操作 ID:
PostEnvelopesEnvelopIdJobsSendNotification

向给定信封的重新定位发送通知。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
问候
 greeting string
收件人 ID
 id True string

通知应发送到的收件人的 ID。

将收件人添加到信封

操作 ID:
PostEnvelopesEnvelopeIdRecipients

将收件人添加到给定信封。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
名字
 givenName True string
姓氏
 familyName True string
语言
 language True string
签名方法
 signingMethod True string
通知方法
 notificationMethod string
电子邮件
 email True string
电话
 telephone string

格式应为 +<countryCode><电话编号>
下单
 order integer
Action
 action True string

已验证收件人应执行的作的名称。
标签
 label True string

收件人的角色/作的标签
Name
 name True string

已验证收件人角色的名称
Secure
 secure boolean
短信
 sms boolean
SSN
 ssn string
银行
 bank string

将文件添加到文档

操作 ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdFiles

将文件添加到现有文档。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
文档 ID
 document-id True string

有问题的文档的 ID
Name
 name True string
FileType
 fileType True string
Hash
 hash string

返回

文件
File

将文档添加到信封

操作 ID:
PostEnvelopesEnvelopeIdDocuments

将新文档添加到现有信封。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
Hash
 hash integer
Name
 name True string
来源
 source string

按 ID 删除信封

操作 ID:
DeleteEnvelopesEnvelopeId

删除给定信封。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID

按 ID 删除文档

操作 ID:
DeleteEnvelopesEnvelopeIdDocumentsDocumentId

删除给定文档。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
文档 ID
 document-id True string

有问题的文档的 ID

按 ID 更新收件人

操作 ID:
PutEnvelopesEnvelopeIdRecipientsRecipientId

更新收件人。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
收件人 ID
 recipient-id True string

有关收件人的 ID
名字
 givenName True string
姓氏
 familyName True string
语言
 language True string
签名方法
 signingMethod True string
通知方法
 notificationMethod string
电子邮件
 email True string
电话
 telephone string

格式应为 +<countryCode><电话编号>
下单
 order integer
Action
 action True string

已验证收件人应执行的作的名称。
标签
 label True string

收件人的角色/作的标签
Name
 name True string

已验证收件人角色的名称
Secure
 secure boolean
短信
 sms boolean
SSN
 ssn string
银行
 bank string

按 ID 获取信封

操作 ID:
GetEnvelopesEnvelopeId

获取给定信封的详细信息。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID

返回

信封
Envelope

按 ID 获取公司

操作 ID:
GetCompaniesCompanyId

获取给定公司的信息。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 company-id True string

有问题的公司的 ID

返回

公司
Company

按 ID 获取描述符

操作 ID:
GetEnvelopeDescriptorsEnvelopeDescriptorId

获取给定描述符的信息。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封描述符 ID
 envelope-descriptor-id True string

信封描述符的 ID

返回

描述符
Descriptor

按 ID 获取文件

操作 ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileId

获取有关给定文件的信息。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
文档 ID
 document-id True string

有问题的文档的 ID
文件 ID
 file-id True string

有问题的文件的 ID

返回

文件
File

按 ID 获取文件 URL

操作 ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileIdUrl

获取给定文件的 URL。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
文档 ID
 document-id True string

有问题的文档的 ID
文件 ID
 file-id True string

有问题的文件的 ID
As 对象
 asObject boolean

定义响应是否为对象

返回

名称 路径 类型 说明
URL
 url string

文件 URL

按 ID 获取文档

操作 ID:
GetEnvelopesEnvelopeIdDocumentsDocumentId

获取给定文档的信息。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
文档 ID
 document-id True string

有问题的文档的 ID

返回

文档
Document

按信封 ID 获取所有文档

操作 ID:
GetEnvelopesEnvelopeIdDocuments

获取与给定信封相关的所有文档。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID

返回

response
array of Document

按信封 ID 获取流状态

操作 ID:
GetFlowsFlowIdJobsEnvelopeId

获取给定信封的当前流状态。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
流 ID
 flow-id True string

有问题的流的 ID

返回

名称 路径 类型 说明
标记
 token string

按文档 ID 获取文件

操作 ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFiles

获取连接到给定文档的所有文件。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
文档 ID
 document-id True string

有问题的文档的 ID

返回

response
array of File

搜索所有信封

操作 ID:
GetSearchEnvelopes

搜索与给定筛选器匹配的所有信封。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
过滤 器
 filters string

筛选查询以选择子装载
来自
 from integer

从日期起
限度
 limit integer

限额
排序
 sort string

排序依据

返回

response
array of EnvelopeDescriptorString

更新信封的发布状态

操作 ID:
PutEnvelopesEnvelopeIdPublishStatus

更新给定信封的发布状态。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
已发布
 published True boolean

更新信封设置

操作 ID:
PutEnvelopesEnvelopeId

更新给定信封的设置。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
顺序签名
 sequentialSigning boolean
问候
 greeting string
过期日期
 expiration date

格式为 2017-02-26T21：59：59.999Z 的日期
自动提醒
 automaticReminders number

到期前的 X 天

查询所有信封（已弃用）

操作 ID:
GetQueryEnvelopes

查询与给定筛选器匹配的所有信封。 （已弃用）

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
过滤 器
 filters string

筛选查询以选择子装载
来自
 from integer

从日期起
限度
 limit integer

限额
排序
 sort string

排序依据

返回

response
array of EnvelopeDescriptorString

生成安全令牌

操作 ID:
PostAuthenticate

从已验证的 API 获取身份验证令牌。

参数

名称 密钥 必需 类型 说明
没有 IP 锁
 withoutIpLock True integer

验证是否激活 IP 锁（0，默认值）（1）

返回

名称 路径 类型 说明
标记
 token string

访问令牌

获取信封的特定收件人

操作 ID:
GetEnvelopesEnvelopeIdRecipientsRecipientId

获取给定信封的特定收件人。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
收件人 ID
 recipient-id True string

有关收件人的 ID

返回

Recipient
Recipient

获取所有信封收件人

操作 ID:
GetEnvelopesEnvelopeIdRecipients

获取给定信封的所有收件人。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID

返回

response
array of Recipient

获取所有描述符

操作 ID:
GetEnvelopeDescriptors

获取当前公司中存在的所有描述符的列表。 可以筛选列表。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
过滤 器
 filters string

筛选查询以选择子装载

返回

response
array of Descriptor

获取用户信息

操作 ID:
GetAuthUserinfo

获取当前登录用户的信息。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌

返回

Body
UserInfo

获取用户设置

操作 ID:
GetCompaniesCompanyIdUsersUserIdSettings

获取给定用户的设置。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 company-id True string

有问题的公司的 ID
用户 ID
 user-id True string

有问题的用户的 ID

返回

Body
Setting

获取默认描述符

操作 ID:
GetEnvelopeDescriptorsDefault

获取信封的默认描述符。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
过滤 器
 filters string

筛选查询以选择子装载

返回

描述符
Descriptor

设置信封中止状态

操作 ID:
PutEnvelopesEnvelopeIdAbortStatus

将给定信封的状态设置为已中止。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
注释
 comment string

设置信封回收站状态

操作 ID:
PutEnvelopesEnvelopeIdTrashStatus

将给定信封的状态设置为已回收。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
注释
 comment string

设置文档中止状态

操作 ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdStatusAborted

将给定文档的状态设置为已中止。

参数

名称 密钥 必需 类型 说明
标记
 token True string

从“生成安全令牌”作接收的令牌
公司 ID
 x-namespace string

应用于作的公司 ID。 设置 /companies/<company ID> 的格式。 如果未设置，则默认为连接公司 ID。
信封 ID
 envelope-id True string

有问题的信封的 ID
文档 ID
 document-id True string

有问题的文档的 ID

定义

设置

名称 路径 类型 说明
全球
 global string
签名语言
 preferences.signatoryLanguage string
问候
 preferences.greeting string
签名方法
 preferences.signingMethod string
提醒偏移量
 preferences.reminderOffset string

用户信息

名称 路径 类型 说明
名字
 givenName string
姓氏
 familyName string
Email
 email string
语言
 metadata.language string
缺少密码
 missingPassword boolean
已启用
 isEnabled boolean
Namespace
 namespace string
已启用
 enabled boolean
用户唯一标识 (UID)
 uid string
Id
 id string
角色
 roles array of Role
Validated
 validated boolean

公司

名称 路径 类型 说明
Name
 name string
Reg. Number
 regNumber string
已创建
 created string
已修改
 modified string
地址
 address string
City
 city string
邮政编码
 zipCode string
Logo
 logo string
国家
 country string
UId
 uid string
Id
 id string

Recipient

名称 路径 类型 说明
用户唯一标识 (UID)
 uid string

收件人 UID
Namespace
 namespace string

收件人命名空间
已创建
 created string

已创建收件人
角色
 role RoleActionString
姓氏
 familyName string

收件人姓氏
名字
 givenName string

Recipient Frist Name
语言
 language string

收件人语言
Email
 email string

收件人电子邮件
签名方法
 signingMethod string

收件人签名 Methid
通知方法
 notificationMethod string
下单
 order integer

收件人订单
Id
 id string

收件人 ID
已修改
 modified string

收件人已修改
通知
 notified boolean
完成
 completed boolean
demandAttachment
 demandAttachment boolean
SSN
 ssn string
银行
 bank string
Secure
 secure boolean
短信
 sms boolean
电话
 telephone string
签名
 signatures object
Notifications
 notifications array of Notification

角色

名称 路径 类型 说明
类型
 action.type string
方法
 action.methods array of string
标签
 label string

标签
Num. 麦克斯
 numMax integer

Num. 麦克斯
Num. 最小值
 numMin integer

Num. 最小值
角色名称
 roleName string

RoleActionString

名称 路径 类型 说明
Action
 action ActionString

Action
标签
 label string

标签
Num. 麦克斯
 numMax integer

Num. 麦克斯
Num. 最小值
 numMin integer

Num. 最小值
角色名称
 roleName string

ActionString

Action

Action

Action
string

信封

名称 路径 类型 说明
Id
 id string

信封 ID
用户唯一标识 (UID)
 uid string

信封 UID
Namespace
 namespace string

信封命名空间
版本
 version integer

信封版本
已发布
 published boolean

已发布信封
完成
 completed boolean

信封已完成
已中止
 aborted boolean

信封 Avorted
毁
 trashed boolean

信封被回收
顺序签名
 sequentialSigning boolean
自动提醒
 automaticReminders integer
已创建
 created string

已创建的信封
已修改
 modified string

已修改信封
已过期
 expired boolean

信封已过期
Flow
 flow Flow
描述符
 descriptor Descriptor
人员
 sender Person
文档
 documents array of Document
收件人
 recipients array of Recipient
标记
 tags array of object
Owners
 owners array of Person

EnvelopeDescriptorString

名称 路径 类型 说明
Id
 id string

信封 ID
用户唯一标识 (UID)
 uid string

信封 UID
Namespace
 namespace string

信封命名空间
版本
 version integer

信封版本
已发布
 published boolean

已发布信封
完成
 completed boolean

信封已完成
已中止
 aborted boolean

信封 Avorted
毁
 trashed boolean

信封被回收
顺序签名
 sequentialSigning boolean
自动提醒
 automaticReminders integer
已创建
 created string

已创建的信封
已修改
 modified string

已修改信封
已过期
 expired boolean

信封已过期
Flow
 flow Flow
描述符
 descriptor string

信封描述符
人员
 sender Person
文档
 documents array of Document
收件人
 recipients array of Recipient
标记
 tags array of object
Owners
 owners array of Person

文件

名称 路径 类型 说明
Id
 id string

文件 ID
URL
 url string

文件 URL
Name
 name string

文件名
哑剧类型
 mimeType string
文件类型
 fileType string
存储路径
 storagePath string
上传位置
 uploadedAt string
已创建
 created string

文件已创建
Owners
 owners array of object
用户唯一标识 (UID)
 owners.uid string

文件所有者 UID
Id
 owners._id string

文件所有者 ID
Namespace
 namespace string
用户唯一标识 (UID)
 uid string

文件 UID

Flow

名称 路径 类型 说明
Id
 id string

流 ID
Name
 name string

流名称

描述符

名称 路径 类型 说明
Name
 name string

描述符名称
版本
 version integer

描述符版本
用户唯一标识 (UID)
 uid string

描述符 UID
已删除
 deleted boolean

描述符 Deletd
公众
 public boolean

描述符公共
已过期
 expired boolean

描述符已过期
Id
 id string

描述符 ID
强制的
 mandatory boolean

描述符必需
标签
 label string

描述符标签
类型
 type string

描述符类型
角色
 roles array of Role
Owners
 owners array of Person
Flow
 flow Flow
defaultValues
 defaultValues DefaultValues

defaultValues
实例
 instances array of object

人员

名称 路径 类型 说明
用户唯一标识 (UID)
 uid string

人员 UID
名字
 givenName string

人员名字
姓氏
 familyName string

人员姓氏
Email
 email string

人员电子邮件
语言
 language string

人员语言
下单
 order integer

人员订单

文档

名称 路径 类型 说明
标签
 label string

文档标签
类型
 type string

文档类型
Hash
 hash integer

文档哈希
Num. 麦克斯
 numMax integer

文档编号。 麦克斯
Num. 最小值
 numMin integer

文档编号。 最小值
用户唯一标识 (UID)
 uid string

文档 UID
Namespace
 namespace string

文档命名空间
来源
 source string

文档源
已创建
 created string

已创建文档
Name
 name string

文档名称
Id
 id string

文档 ID
已修改
 modified string

文档已修改
Rejected
 rejected boolean

文档被拒绝
Signed
 signed boolean

文档签名
毁
 trashed boolean

文档已回收
已中止
 aborted boolean

文档中止
版本
 version integer

文档版本
attachments
 attachments array of Attachment
Flow
 flow Flow
roles
 roles array of Role
Template
 template Template
描述符
 descriptor Descriptor
签名
 signatures array of Signature

附件

名称 路径 类型 说明
标签
 label string

附件标签
Num. 麦克斯
 numMax integer

附件 Num。 麦克斯
Num. 最小值
 numMin integer

Attachment Num.Min
Hash
 hash integer

附件哈希

Template

名称 路径 类型 说明
类型
 type string

模板类型
HTML
 html string
PDFHTML
 pdfHtml string
Id
 id string
用户唯一标识 (UID)
 uid string
Namespace
 namespace string
版本
 version integer
已创建
 created string
已修改
 modified string
已修改
 published boolean
完成
 completed boolean
已中止
 aborted boolean

Signature

名称 路径 类型 说明
ID
 id string
Origin
 origin string
名字
 givenName string

名字
姓氏
 familyName string

姓氏
Email
 email string

Email
IP
 ip string
日期
 date string
状态
 status string
注释
 comment string

DefaultValues

defaultValues

名称 路径 类型 说明
人员
 signer Person
人员
 reviewer Person

通知

名称 路径 类型 说明
ID
 id string
用户唯一标识 (UID)
 uid string
Namespace
 namespace string
状态
 status string
下单
 order integer
详细信息
 details object
日期
 date string