已驗證
已驗證 API 的連接器，以啟用自訂文件簽署程序的建立。
此連接器適用於以下產品和區域：
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域， 但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部 （DoD） |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| Power Automate（自動化服務） | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 連絡人 | |
|---|---|
| 名稱 | 已驗證 |
| URL | https://verified.eu/en/#about-us |
| support@verified.eu |
| 連接器中繼資料 | |
|---|---|
| Publisher | Crm - Konsulterna i Sverige AB |
| 網站 | https://verified.eu/ |
| 隱私策略 | https://verified.eu/trust-center |
| 類別 | 內容和文件;生產力 |
Verified 是一家提供電子識別和數字簽名的軟件即服務提供商。 此連接器可讓您整合至已驗證的 API，並在應用程式內建立簡單直覺的簽署程式。
先決條件
您將需要以下內容才能繼續：
- 註冊 已驗證帳戶
如何取得認證
此連接器使用基本驗證。 用戶在創建連接時必須提供用戶名、密碼和公司 ID。 使用者名稱和密碼與您登入已驗證入口網站時使用的使用者名稱和密碼相同。 要獲取公司 ID，您必須登錄到已驗證門戶，選擇正確的公司（如果您有多個公司），然後從 URL 複製公司 ID。
開始
常見的使用案例是啟動和管理簽署程序，即設定自動化，將要簽署的文件傳送至已驗證，並定期取回已簽署的文件。 用於啟動「已驗證」簽署程序的常見動作包括建立信封 - 描述元或建立信封 - 預設、將文件新增至信封、將檔案新增至文件、將收件人新增至信封和更新信封的發佈狀態。 用於檢查文檔的已驗證狀態的常見操作包括按id獲取信封、按信封ID獲取所有文檔、按文檔ID獲取檔案、通過ID獲取檔案URL。請注意，動作 產生安全權杖 一律會作為第一個步驟，以取得要在下列步驟中使用的安全權杖。
已知問題和限制
目前已知以下限制。
- 在每個流程的開始，都必須建立驗證權杖，以便在後續每個步驟中重複使用。
- 要添加文檔，必須向特定 url 發送 HTTP 請求。
- 要使用新的搜尋端點，必須透過已驗證的 Suport，為該帳號啟用。
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))
如何從信封取得 Flow ID？
當載入有關信封的資訊時，相關流程將成為回應的一部分（例如：「/flow/default」）。 在回應中，它稱為流程的 ID，但是當另一個步驟（例如獲取流程狀態）要求流程 ID 時，只需要最後一部分。
以下是有關如何執行此操作的範例
substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)
我該如何使用新的搜尋動作？
要使用新的搜尋動作，搜尋端點必須啟用您的已驗證組織。 要做到這點，你必須寫信給已驗證支援，附上你的組織編號，讓他們幫你啟動端點。
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 使用者名稱 | securestring | 此 API 的使用者名稱 | 對 |
| 密碼 | securestring | 此 API 的密碼 | 對 |
| 公司編號 | 字串 | 公司 ID 由 Verify 提供。 登入網址即可找到 app.verified.eu | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 依 ID 刪除信封 |
刪除指定的信封。 |
| 依 ID 刪除文件 |
刪除指定的文件。 |
| 依 ID 取得文件 |
取得指定文件的資訊。 |
| 依 ID 取得檔案 |
取得指定檔案的相關資訊。 |
| 依 ID 取得檔案 URL |
取得指定檔案的網址。 |
| 依ID更新收件者 |
更新收件者。 |
| 依信封 ID 取得所有文件 |
取得與指定信封相關的所有文件。 |
| 依信封識別碼取得流程狀態 |
取得指定信封的目前流程狀態。 |
| 依文件識別碼取得檔案 |
取得連線至指定文件的所有檔案。 |
| 依識別碼取得描述元 |
取得指定描述元的資訊。 |
| 傳送通知 |
傳送通知給指定信封的收件人。 |
| 取得使用者設定 |
取得指定使用者的設定。 |
| 取得使用者資訊 |
取得目前登入使用者的資訊。 |
| 取得信封的特定收件人 |
取得指定信封的特定收件人。 |
| 取得所有信封收件人 |
取得指定信封的所有收件人。 |
| 取得所有描述元 |
取得目前公司中存在的所有描述元的清單。 該列表可以過濾。 |
| 取得預設描述元 |
取得信封的預設描述元。 |
| 將收件人新增至信封 |
將收件人新增至指定的信封。 |
| 將文件新增至信封 |
將新文件新增至現有信封。 |
| 將檔案新增至文件 |
將檔案新增至現有文件。 |
| 建立信封 - 預設 |
使用預設描述子建立新信封。 |
| 建立信封 — 描述元 |
根據特定描述元建立信封。 |
| 建立簽名連結 |
建立簽名連結。 實作是流程特定的，您的特定流程可能缺少。 |
| 從範本產生文件 |
從預先設定的範本產生文件。 |
| 搜查所有信封 |
搜尋所有符合特定濾波器的信封。 |
| 更新信封的發佈狀態 |
更新指定信封的發佈狀態。 |
| 更新信封設定 |
更新指定信封的設定。 |
| 查詢所有信封（已棄用） |
查詢符合指定篩選器的所有信封。 （已棄用） |
| 產生安全性權杖 |
從已驗證的 API 取得驗證權杖。 |
| 設定信封中止狀態 |
將指定信封的狀態設定為已中止。 |
| 設定信封垃圾桶狀態 |
將指定信封的狀態設定為已廢棄。 |
| 設定文件中止狀態 |
將指定文件的狀態設定為已中止。 |
| 透過身分證件取得信封 |
取得指定信封的詳細資料。 |
| 通過 ID 獲取公司 |
取得給定公司的資訊。 |
依 ID 刪除信封
刪除指定的信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
依 ID 刪除文件
刪除指定的文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
文件標識碼
|
document-id | True | string |
相關文件的 ID |
依 ID 取得文件
取得指定文件的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
文件標識碼
|
document-id | True | string |
相關文件的 ID |
傳回
- 文件
- Document
依 ID 取得檔案
取得指定檔案的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
文件標識碼
|
document-id | True | string |
相關文件的 ID |
|
檔案標識碼
|
file-id | True | string |
相關檔案的 ID |
傳回
- 檔案
- File
依 ID 取得檔案 URL
取得指定檔案的網址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
文件標識碼
|
document-id | True | string |
相關文件的 ID |
|
檔案標識碼
|
file-id | True | string |
相關檔案的 ID |
|
作為物件
|
asObject | boolean |
定義回應是否為物件 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
檔案網址 |
依ID更新收件者
更新收件者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company 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 | ||
|
電子郵件
|
True | string | ||
|
電話
|
telephone | string |
格式應為 +<countryCode><電話號碼> |
|
|
訂單
|
order | integer | ||
|
行動
|
action | True | string |
收件者應執行之動作的已驗證名稱。 |
|
標籤
|
label | True | string |
收件者角色/動作的標籤 |
|
名稱
|
name | True | string |
已驗證收件者角色的名稱 |
|
安全
|
secure | boolean | ||
|
SMS
|
sms | boolean | ||
|
SSN
|
ssn | string | ||
|
銀行
|
bank | string |
依信封 ID 取得所有文件
取得與指定信封相關的所有文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
傳回
- response
- array of Document
依信封識別碼取得流程狀態
取得指定信封的目前流程狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
流程 ID
|
flow-id | True | string |
相關流程的 ID |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
代幣
|
token | string |
依文件識別碼取得檔案
取得連線至指定文件的所有檔案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
文件標識碼
|
document-id | True | string |
相關文件的 ID |
傳回
- response
- array of File
依識別碼取得描述元
取得指定描述元的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封描述元 ID
|
envelope-descriptor-id | True | string |
信封描述元的 ID |
傳回
- 描述元
- Descriptor
傳送通知
傳送通知給指定信封的收件人。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
問候
|
greeting | string | ||
|
收件者 ID
|
id | True | string |
應傳送通知的收件者識別碼。 |
取得使用者設定
取得指定使用者的設定。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
company-id | True | string |
相關公司的 ID |
|
使用者 ID
|
user-id | True | string |
相關使用者的 ID |
傳回
- 身體
- Setting
取得使用者資訊
取得信封的特定收件人
取得指定信封的特定收件人。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
收件者 ID
|
recipient-id | True | string |
相關收件者的ID |
傳回
- Recipient
- Recipient
取得所有信封收件人
取得指定信封的所有收件人。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
傳回
- response
- array of Recipient
取得所有描述元
取得目前公司中存在的所有描述元的清單。 該列表可以過濾。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
篩選
|
filters | string |
篩選查詢以選取子金額 |
傳回
- response
- array of Descriptor
取得預設描述元
取得信封的預設描述元。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
篩選
|
filters | string |
篩選查詢以選取子金額 |
傳回
- 描述元
- Descriptor
將收件人新增至信封
將收件人新增至指定的信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
名字
|
givenName | True | string | |
|
姓氏
|
familyName | True | string | |
|
語言
|
language | True | string | |
|
簽署方式
|
signingMethod | True | string | |
|
通知方式
|
notificationMethod | string | ||
|
電子郵件
|
True | string | ||
|
電話
|
telephone | string |
格式應為 +<countryCode><電話號碼> |
|
|
訂單
|
order | integer | ||
|
行動
|
action | True | string |
收件者應執行之動作的已驗證名稱。 |
|
標籤
|
label | True | string |
收件者角色/動作的標籤 |
|
名稱
|
name | True | string |
已驗證收件者角色的名稱 |
|
安全
|
secure | boolean | ||
|
SMS
|
sms | boolean | ||
|
SSN
|
ssn | string | ||
|
銀行
|
bank | string |
將文件新增至信封
將新文件新增至現有信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
Hash
|
hash | integer | ||
|
名稱
|
name | True | string | |
|
來源
|
source | string |
將檔案新增至文件
將檔案新增至現有文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
文件標識碼
|
document-id | True | string |
相關文件的 ID |
|
名稱
|
name | True | string | |
|
FileType
|
fileType | True | string | |
|
Hash
|
hash | string |
傳回
- 檔案
- File
建立信封 - 預設
使用預設描述子建立新信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
Email
|
string | |||
|
名字
|
givenName | string | ||
|
姓氏
|
familyName | string | ||
|
自動提醒
|
automaticReminders | number | ||
|
Expiration
|
expiration | string | ||
|
Hash
|
hash | string |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
uid
|
uid | string |
建立信封 — 描述元
根據特定描述元建立信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封描述元 ID
|
envelope-descriptor-id | True | string |
信封描述元的 ID |
|
Email
|
string | |||
|
名字
|
givenName | string | ||
|
姓氏
|
familyName | string | ||
|
自動提醒
|
automaticReminders | number | ||
|
Expiration
|
expiration | string | ||
|
Hash
|
hash | string |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
uid
|
uid | string |
建立簽名連結
建立簽名連結。 實作是流程特定的，您的特定流程可能缺少。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
Id
|
id | string | ||
|
重新導向至
|
redirectTo | uri |
完整 URL，以將使用者重新導向至簽署後。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
getSignLink.recipient.{recipient-id}.url | string |
從範本產生文件
從預先設定的範本產生文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
文件標識碼
|
document-id | True | string |
相關文件的 ID |
|
範本識別碼
|
template-id | True | string |
應該使用的範本標識碼 |
|
|
object |
搜查所有信封
搜尋所有符合特定濾波器的信封。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
篩選
|
filters | string |
篩選查詢以選取子金額 |
|
|
寄件者
|
from | integer |
從日期開始 |
|
|
限制
|
limit | integer |
限額金額 |
|
|
排序
|
sort | string |
排序方式 |
傳回
- response
- array of EnvelopeDescriptorString
更新信封的發佈狀態
更新指定信封的發佈狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
發布
|
published | True | boolean |
更新信封設定
更新指定信封的設定。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
順序簽署
|
sequentialSigning | boolean | ||
|
問候
|
greeting | string | ||
|
Expiration
|
expiration | date |
日期格式如下：2017-02-26T21：59：59.999Z |
|
|
自動提醒
|
automaticReminders | number |
到期前 X 天 |
查詢所有信封（已棄用）
查詢符合指定篩選器的所有信封。 （已棄用）
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
篩選
|
filters | string |
篩選查詢以選取子金額 |
|
|
寄件者
|
from | integer |
從日期開始 |
|
|
限制
|
limit | integer |
限額金額 |
|
|
排序
|
sort | string |
排序方式 |
傳回
- response
- array of EnvelopeDescriptorString
產生安全性權杖
從已驗證的 API 取得驗證權杖。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
無IP鎖
|
withoutIpLock | True | integer |
已驗證是否啟動 IP 鎖定 （0，預設） （1） |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
代幣
|
token | string |
存取憑證 |
設定信封中止狀態
將指定信封的狀態設定為已中止。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
留言
|
comment | string |
設定信封垃圾桶狀態
將指定信封的狀態設定為已廢棄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
評論
|
comment | string |
設定文件中止狀態
將指定文件的狀態設定為已中止。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
|
文件標識碼
|
document-id | True | string |
相關文件的 ID |
透過身分證件取得信封
取得指定信封的詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
x-namespace | string |
應用於動作的公司 ID。 格式 /companies/<company id>。 如果未設定，則預設為連線公司識別碼。 |
|
|
信封ID
|
envelope-id | True | string |
相關信封的 ID |
傳回
- 信封
- Envelope
通過 ID 獲取公司
取得給定公司的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
代幣
|
token | True | string |
從「產生安全性權杖」動作收到的權杖 |
|
公司編號
|
company-id | True | string |
相關公司的 ID |
傳回
- 公司
- Company
定義
Setting
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
全球
|
global | string | |
|
簽署語言
|
preferences.signatoryLanguage | string | |
|
問候
|
preferences.greeting | string | |
|
簽署方式
|
preferences.signingMethod | string | |
|
提醒偏移
|
preferences.reminderOffset | string |
UserInfo
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名字
|
givenName | string | |
|
姓氏
|
familyName | string | |
|
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 |
公司
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string | |
|
註冊號碼
|
regNumber | string | |
|
已建立
|
created | string | |
|
修改
|
modified | string | |
|
Address
|
address | string | |
|
城市
|
city | string | |
|
郵遞區號
|
zipCode | string | |
|
商標
|
logo | string | |
|
國家
|
country | string | |
|
UId
|
uid | string | |
|
Id
|
id | string |
Recipient
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
UID
|
uid | string |
收件者 UID |
|
Namespace
|
namespace | string |
收件者命名空間 |
|
已建立
|
created | string |
已建立收件者 |
|
Role
|
role | RoleActionString | |
|
姓氏
|
familyName | string |
收件者姓氏 |
|
名字
|
givenName | string |
收件人姓名 |
|
語言
|
language | string |
收件人語言 |
|
Email
|
string |
收件者電子郵件 |
|
|
簽署方式
|
signingMethod | string |
收件人簽署 Methid |
|
通知方式
|
notificationMethod | string | |
|
訂單
|
order | integer |
收件者順序 |
|
Id
|
id | string |
收件者 ID |
|
修改
|
modified | string |
收件人已修改 |
|
已通知
|
notified | boolean | |
|
完成
|
completed | boolean | |
|
需求附件
|
demandAttachment | boolean | |
|
SSN
|
ssn | string | |
|
銀行
|
bank | string | |
|
安全
|
secure | boolean | |
|
SMS
|
sms | boolean | |
|
電話
|
telephone | string | |
|
簽名
|
signatures | object | |
|
通知
|
notifications | array of Notification |
Role
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
類型
|
action.type | string | |
|
方法
|
action.methods | array of string | |
|
標籤
|
label | string |
標籤 |
|
數字。 麥克斯
|
numMax | integer |
數字。 麥克斯 |
|
數字。 最小值
|
numMin | integer |
數字。 最小值 |
|
角色名稱
|
roleName | string |
角色動作字串
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
行動
|
action | ActionString |
行動 |
|
標籤
|
label | string |
標籤 |
|
數字。 麥克斯
|
numMax | integer |
數字。 麥克斯 |
|
數字。 最小值
|
numMin | integer |
數字。 最小值 |
|
角色名稱
|
roleName | string |
動作字串
信封
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Id
|
id | string |
信封ID |
|
UID
|
uid | string |
信封 UID |
|
Namespace
|
namespace | string |
信封命名空間 |
|
版本
|
version | integer |
信封版本 |
|
發布
|
published | boolean |
信封已發布 |
|
完成
|
completed | boolean |
信封完成 |
|
已中止
|
aborted | boolean |
信封已宣稱 |
|
垃圾
|
trashed | boolean |
信封被丟棄 |
|
順序簽署
|
sequentialSigning | boolean | |
|
自動提醒
|
automaticReminders | integer | |
|
已建立
|
created | string |
建立信封 |
|
修改
|
modified | string |
修改信封 |
|
已過期
|
expired | boolean |
信封已過期 |
|
Flow
|
flow | Flow | |
|
描述元
|
descriptor | Descriptor | |
|
Person
|
sender | Person | |
|
Documents
|
documents | array of Document | |
|
收件者
|
recipients | array of Recipient | |
|
Tags
|
tags | array of object | |
|
業主
|
owners | array of Person |
EnvelopeDescriptorString
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Id
|
id | string |
信封ID |
|
UID
|
uid | string |
信封 UID |
|
Namespace
|
namespace | string |
信封命名空間 |
|
版本
|
version | integer |
信封版本 |
|
發布
|
published | boolean |
信封已發布 |
|
完成
|
completed | boolean |
信封完成 |
|
已中止
|
aborted | boolean |
信封已宣稱 |
|
垃圾
|
trashed | boolean |
信封被丟棄 |
|
順序簽署
|
sequentialSigning | boolean | |
|
自動提醒
|
automaticReminders | integer | |
|
已建立
|
created | string |
建立信封 |
|
修改
|
modified | string |
修改信封 |
|
已過期
|
expired | boolean |
信封已過期 |
|
Flow
|
flow | Flow | |
|
描述元
|
descriptor | string |
信封描述元 |
|
Person
|
sender | Person | |
|
Documents
|
documents | array of Document | |
|
收件者
|
recipients | array of Recipient | |
|
Tags
|
tags | array of object | |
|
業主
|
owners | array of Person |
檔案
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Id
|
id | string |
檔案標識碼 |
|
URL
|
url | string |
檔案網址 |
|
名稱
|
name | string |
檔案名稱 |
|
MimeType
|
mimeType | string | |
|
檔案類型
|
fileType | string | |
|
儲存路徑
|
storagePath | string | |
|
上傳於
|
uploadedAt | string | |
|
已建立
|
created | string |
建立的檔案 |
|
業主
|
owners | array of object | |
|
UID
|
owners.uid | string |
檔案擁有者 UID |
|
Id
|
owners._id | string |
檔案擁有者 ID |
|
Namespace
|
namespace | string | |
|
UID
|
uid | string |
檔案UID |
Flow
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Id
|
id | string |
流程 ID |
|
名稱
|
name | string |
流程名稱 |
描述元
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
描述元名稱 |
|
版本
|
version | integer |
描述元版本 |
|
UID
|
uid | string |
描述子 UID |
|
已刪除
|
deleted | boolean |
描述元已刪除 |
|
公開
|
public | boolean |
描述子公用 |
|
已過期
|
expired | boolean |
描述元已過期 |
|
Id
|
id | string |
描述元識別碼 |
|
強制的
|
mandatory | boolean |
描述元必要 |
|
標籤
|
label | string |
描述元標籤 |
|
類型
|
type | string |
描述元類型 |
|
角色
|
roles | array of Role | |
|
業主
|
owners | array of Person | |
|
Flow
|
flow | Flow | |
|
defaultValues
|
defaultValues | DefaultValues |
defaultValues |
|
實例
|
instances | array of object |
Person
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
UID
|
uid | string |
人 UID |
|
名字
|
givenName | string |
人名 |
|
姓氏
|
familyName | string |
人姓氏 |
|
Email
|
string |
人員電子郵件 |
|
|
語言
|
language | string |
人稱語言 |
|
訂單
|
order | integer |
人員順序 |
文件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
標籤
|
label | string |
文件標籤 |
|
類型
|
type | string |
文件類型 |
|
Hash
|
hash | integer |
文件雜湊 |
|
數字。 麥克斯
|
numMax | integer |
文件編號。 麥克斯 |
|
數字。 最小值
|
numMin | integer |
文件編號。 最小值 |
|
UID
|
uid | string |
文件 UID |
|
Namespace
|
namespace | string |
文件命名空間 |
|
來源
|
source | string |
文件來源 |
|
已建立
|
created | string |
已建立文件 |
|
名稱
|
name | string |
文件名稱 |
|
Id
|
id | string |
文件標識碼 |
|
修改
|
modified | string |
文件已修改 |
|
已拒絕
|
rejected | boolean |
文件被拒絕 |
|
簽名
|
signed | boolean |
簽署文件 |
|
垃圾
|
trashed | boolean |
文件已丟棄 |
|
已中止
|
aborted | boolean |
文件已中止 |
|
版本
|
version | integer |
文件版本 |
|
attachments
|
attachments | array of Attachment | |
|
Flow
|
flow | Flow | |
|
角色
|
roles | array of Role | |
|
Template
|
template | Template | |
|
描述元
|
descriptor | Descriptor | |
|
簽名
|
signatures | array of Signature |
Attachment
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
標籤
|
label | string |
附件標籤 |
|
數字。 麥克斯
|
numMax | integer |
附件編號。 麥克斯 |
|
數字。 最小值
|
numMin | integer |
附件 Num.Min |
|
Hash
|
hash | integer |
附件雜湊 |
Template
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
類型
|
type | string |
範本類型 |
|
HTML
|
html | string | |
|
PDF格式
|
pdfHtml | string | |
|
Id
|
id | string | |
|
UID
|
uid | string | |
|
Namespace
|
namespace | string | |
|
版本
|
version | integer | |
|
已建立
|
created | string | |
|
修改
|
modified | string | |
|
修改
|
published | boolean | |
|
完成
|
completed | boolean | |
|
已中止
|
aborted | boolean |
Signature
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string | |
|
Origin
|
origin | string | |
|
名字
|
givenName | string |
名字 |
|
姓氏
|
familyName | string |
姓氏 |
|
Email
|
string |
|
|
|
IP
|
ip | string | |
|
Date
|
date | string | |
|
地位
|
status | string | |
|
評論
|
comment | string |
預設值
defaultValues
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Person
|
signer | Person | |
|
Person
|
reviewer | Person |
Notification
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string | |
|
UID
|
uid | string | |
|
Namespace
|
namespace | string | |
|
地位
|
status | string | |
|
訂單
|
order | integer | |
|
詳細資訊
|
details | object | |
|
Date
|
date | string |