共用方式為

Dokobit 通用 API

Dokobit Universal API 是一款多功能工具，可讓您在系統內部簽署文檔，並從歐洲系統外部的第三方收集簽名。 文件簽署發生在無帳戶 Dokobit 簽署 （受邀參與者無需在 Dokobit 入口網站上註冊即可簽署文件） 介面中，並具有您組織的品牌。

此連接器適用於以下產品和區域：

服務 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://support.dokobit.com
Email developers@dokobit.com
連接器中繼資料
Publisher 多科比特
網站 https://www.dokobit.com/solutions
隱私策略 https://www.dokobit.com/compliance/privacy-policy
類別 生產力

Dokobit Universal API 是一款多功能工具，可讓您在系統內部簽署文檔，並從歐洲系統外部的第三方收集簽名。 文件簽署發生在無帳戶 Dokobit 簽署 （受邀參與者無需在 Dokobit 入口網站上註冊即可簽署文件） 介面中，並具有您組織的品牌。

先決條件

為了使用 Dokobit Universal API，請聯繫我們 sales@dokobit.com 以獲取 API 訪問令牌。

如何取得認證

請聯絡 我們的銷售人員以取得 API 存取權杖

開始使用連接器

  • 可以使用「DokobitUniversalAPICreateExternalSigning」或「DokobitUniversalAPICreateInternalSigning」操作啟動文件簽署。 使用“DokobitUniversalAPICreateExternalSigning”將向參與者發送簽名邀請。 'DokobitUniversalAPICreateInternalSigning' 將生成一個簽名 URL，用戶可以在其中重定向。
  • 然後，可以使用相應的操作來管理簽名，允許您添加/刪除參與者、發送提醒或檢查文檔簽名狀態。
  • 參與者簽署文件後，可以使用「DokobitUniversalAPIDownloadDocumentExternal」或「DokobitUniversalAPIDownloadDocumentInternal」操作下載文件。

已知問題與限制

目前的實作支援 PDF 檔案上的簽章收集，並受 ASiCe、ADoc、BDoc 或 EDoc 容器的支援。

常見錯誤和補救措施

  • 檔案必須以 Base64 編碼的檔案內容提供。
  • 如果文件簽署「類型」設定為「pdf」，則在啟動文件簽署時將接受單一 PDF 文件。 對於多個檔案，請將簽署 'Type' 設定為 'asice' 或其他容器格式。

正在建立連線

連接器支援下列驗證類型：
預設值 建立連線的參數。 所有區域 不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
API 金鑰 securestring 此 API 的 API 金鑰 對

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

Validation

Dokobit 是一家經過 eIDAS 認證的服務提供商，提供合格的電子簽名和電子印章驗證。 使用此動作可上傳已簽署的檔案以進行驗證。 支援的檔案類型：asice、asics、edocbdocpdfscep7s、、。 xml
下載文件內部

下載已簽署的文件。
下載文件外部

下載已簽署的文件。
刪除內部簽署

該文件將從所有者的帳戶中刪除。 其他參與者仍可訪問它。
刪除內部簽署者

指定參與者將撤銷對文件的存取權。
刪除外部簽署

該文件將從所有者的帳戶中刪除。 其他參與者仍可訪問它。
刪除外部簽署者

指定參與者將撤銷對文件的存取權。
印章簽名

文件將用您組織的電子印章蓋章。 請聯絡我們的支援人員 developers@dokobit.com ，以取得合格的電子封條證書。
建立內部簽署

內部簽署會從您的系統起始簽署要求。 在此情況下，會產生簽署 URL，參與者應該重新導向。
建立外部簽署

外部簽署會從您的系統起始非同步簽署要求。 在這種情況下，使用者會收到一封用於簽署的電子郵件，一旦他簽署文件，您將收到回電。
新增內部簽署者

指定的參與者將獲得具有所選角色的文件的存取權。
新增外部簽署者

指定的參與者將獲得具有所選角色的文件的存取權。
更新內部簽署

允許更新現有文件簽署的屬性。
更新外部簽署

允許更新現有文件簽署的屬性。
檢查內部簽署狀態

傳回具有簽署狀態的文件資訊。
檢查外部簽署狀態

傳回具有簽署狀態的文件資訊。
發送提醒

允許向參與者發送提醒電子郵件，僅當人員尚未簽署文檔時。 僅適用於外部簽署流程。
電子送貨

Document e-Delivery 用於與 Dokobit Universal API 安全地共享文檔。
驗證 - PDF 報告

下載 PDF 格式的驗證報告。
驗證 - XML 報告

下載 XML 格式的驗證報告。
驗證 - XML 診斷資料

以 XML 下載診斷資料。
驗證 - 詳細的 PDF 報告

下載 PDF 格式的詳細驗證報告。

Validation

作業識別碼：
DokobitUniversalAPIValidation

Dokobit 是一家經過 eIDAS 認證的服務提供商，提供合格的電子簽名和電子印章驗證。 使用此動作可上傳已簽署的檔案以進行驗證。 支援的檔案類型：asice、asics、edocbdocpdfscep7s、、。 xml

參數

名稱 機碼 必要 類型 Description
名稱
 name True string

檔案名稱。
Content
 content True string

Base64 編碼的檔案內容。

傳回

名稱 路徑 類型 Description
上傳狀態
 status string

上傳狀態。
驗證權杖
 token string

驗證權杖。

下載文件內部

作業識別碼：
DokobitUniversalAPIDownloadDocumentInternal

下載已簽署的文件。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。

傳回

response
object

下載文件外部

作業識別碼：
DokobitUniversalAPIDownloadDocumentExternal

下載已簽署的文件。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。

傳回

response
object

刪除內部簽署

作業識別碼：
DokobitUniversalAPIDeleteInternalSigning

該文件將從所有者的帳戶中刪除。 其他參與者仍可訪問它。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。

刪除內部簽署者

作業識別碼：
DokobitUniversalAPIDeleteInternalSigner

指定參與者將撤銷對文件的存取權。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。
代幣
 token True string

參與者的權杖。

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。

刪除外部簽署

作業識別碼：
DokobitUniversalAPIDeleteExternalSigning

該文件將從所有者的帳戶中刪除。 其他參與者仍可訪問它。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。

刪除外部簽署者

作業識別碼：
DokobitUniversalAPIDeleteExternalSigner

指定參與者將撤銷對文件的存取權。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。
代幣
 token True string

參與者的權杖。

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。

印章簽名

作業識別碼：
DokobitUniversalAPISealSigning

文件將用您組織的電子印章蓋章。 請聯絡我們的支援人員 developers@dokobit.com ，以取得合格的電子封條證書。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。
自訂原因
 custom_reason string

自訂簽章原因。
頁面
 page string

可見 PDF 簽名註釋的頁面索引。 僅適用於PDF類型簽名。 預設值：1。
從上到下的位置
 top string

從頂部開始放置 （以點為單位） 以表示可見的 PDF 簽名註釋。 僅適用於PDF類型簽名。 預設值：1。
從左邊開始的位置
 left string

從左邊開始放置 （以點為單位） 以表示可見的 PDF 簽名註解。 僅適用於PDF類型簽名。 預設值：1。

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。

建立內部簽署

作業識別碼：
DokobitUniversalAPICreateInternalSigning

內部簽署會從您的系統起始簽署要求。 在此情況下，會產生簽署 URL，參與者應該重新導向。

參數

名稱 機碼 必要 類型 Description
類型
 type True string

文件格式。 可用值： pdf， asice， ， bdoc， edocadoc， ， . adoc.cedoc
名稱
 name True string

顯示使用者的簽署名稱。
重定向 URI
 redirect_uri True string

重新導向 uri，在簽署完成後將用於重新導向簽署者。
回傳網址
 postback_url string

用於處理 Webhook 的系統 URL。
需要合格的簽名
 require_qualified_signatures boolean

只允許使用合格的簽名進行簽名。 預設值：false。
註解位置
 annotation_position string

您可以選擇 PDF 文件上簽名註解的位置。 可用值： first_top， first_bottom， ， last_toplast_bottom， 。 none 預設值：first_top。
註解個人代碼
 annotation_personal_code boolean

如果設定為 true 個人程式碼，則會在註釋中可見。 僅適用於PDF類型簽名。 預設值：false。
允許視訊識別
 allow_video_identification boolean

允許使用基於視頻的識別進行簽名。 預設值：false。
平面化 PDF
 flatten_pdf boolean

如果設定為true，則文件將被平面化，以便表單欄位成為文件內容的一部分，並且在簽署後無法編輯。 僅適用於PDF類型簽名。 預設值：false。
允許的簽署方法
 allowed_signing_methods array of string

只允許特定的簽署方法。 可用值：mobile、、 eparaksts_mobileitsmeelectronic_ididinswisscomsmartcardbankid_sesms_otpbankid_noaudkenni_appftnmitidsmartid
名稱
 name True string

檔案名稱。
Content
 content True string

Base64 編碼的檔案內容。
外部 ID
 external_id True string

系統中參與者的唯一隨機識別碼。 如果您沒有唯一的隨機識別碼，則可以產生唯一的隨機識別碼。
Role
 role string

參與者的角色。 可用值： signer， viewer. 預設值：signer。
Code
 code string

參與者的代碼。
國家代碼
 country_code string

參與者的國家/地區代碼。 如果提供個人代碼，則為必填。 可用值： LT、 LV、 EE、 IS、 SENOFIPLBE。
電話
 phone string

參與者的電話。
通知語言
 language string

設定使用者介面語言。 可用值：en、、 etfidklvnonlisfrsedelt
頁面
 page string

可見 PDF 簽名註釋的頁面索引。 僅適用於PDF類型簽名。 預設值：1。
從上到下的位置
 top string

從頂部開始放置 （以點為單位） 以表示可見的 PDF 簽名註釋。 僅適用於PDF類型簽名。 預設值：1。
從左邊開始的位置
 left string

從左邊開始放置 （以點為單位） 以表示可見的 PDF 簽名註解。 僅適用於PDF類型簽名。 預設值：1。
語言
 language string

可見 PDF 簽名註釋的語言。 僅適用於PDF類型簽名。 可用值： en， ， lt， lvet，is
自訂原因
 custom_reason string

自訂簽章原因。

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。
簽署權杖
 token string

簽署權杖。
簽署者
 signers array of object

參與者的資訊。
外部 ID
 signers.external_id string

系統中參與者的唯一隨機識別碼。
代幣
 signers.token string

參與者的權杖。
重定向 URI
 signers.redirect_uri string

簽署的 URL。

建立外部簽署

作業識別碼：
DokobitUniversalAPICreateExternalSigning

外部簽署會從您的系統起始非同步簽署要求。 在這種情況下，使用者會收到一封用於簽署的電子郵件，一旦他簽署文件，您將收到回電。

參數

名稱 機碼 必要 類型 Description
類型
 type True string

文件格式。 可用值： pdf， asice， ， bdoc， edocadoc， ， . adoc.cedoc
名稱
 name True string

顯示使用者的簽署名稱。
回傳網址
 postback_url string

用於處理 Webhook 的系統 URL。
Deadline
 deadline date-time

具有指定時區片段的簽署截止日期。 範例：2018-11-05T13：15：30Z。
硬性截止日期
 hard_deadline boolean

如果設定為 ， true 則參與者將無法在設定 deadline之後簽署此文件。 預設值：false。
需要合格的簽名
 require_qualified_signatures boolean

只允許使用合格的簽名進行簽名。 預設值：false。
註解位置
 annotation_position string

您可以選擇 PDF 文件上簽名註解的位置。 可用值： first_top， first_bottom， ， last_toplast_bottom， 。 none 預設值：first_top。
註解個人代碼
 annotation_personal_code boolean

如果設定為 true 個人程式碼，則會在註釋中可見。 僅適用於PDF類型簽名。 預設值：false。
評論
 comment string

給參與者的訊息。
允許視訊識別
 allow_video_identification boolean

允許使用基於視頻的識別進行簽名。 預設值：false。
允許儲存文件
 allow_document_saving boolean

允許用戶將文檔保存到 Dokobit 門戶並採取進一步操作。 預設值：true。
平面化 PDF
 flatten_pdf boolean

如果設定為true，則文件將被平面化，以便表單欄位成為文件內容的一部分，並且在簽署後無法編輯。 僅適用於PDF類型簽名。 預設值：false。
允許的簽署方法
 allowed_signing_methods array of string

只允許特定的簽署方法。 可用值：mobile、、 eparaksts_mobileitsmeelectronic_ididinswisscomsmartcardbankid_sesms_otpbankid_noaudkenni_appftnmitidsmartid
名稱
 name True string

檔案名稱。
Content
 content True string

Base64 編碼的檔案內容。
外部 ID
 external_id True string

系統中參與者的唯一隨機識別碼。 如果您沒有唯一的隨機識別碼，則可以產生唯一的隨機識別碼。
名稱
 name string

參與者的姓名。
Surname
 surname string

參與者的姓氏。
電子郵件
 email string

參與者的電子郵件。
Code
 code string

參與者的個人代碼（國民身份證號碼）。
國碼 (地區碼)
 country_code string

參與者的國家/地區代碼。 如果提供個人代碼，則為必填。 可用值： LT， LV， EEBEISNOFI。 SE
Role
 role string

參與者的角色。 可用值： signer， viewer. 預設值：signer。
公司
 company string

參與者的公司名稱。
Position
 position string

參與者的立場。
電話
 phone string

參與者的電話號碼。
Sequence
 sequence integer

允許設定文件核准和簽署動作的順序。
通知語言
 notifications_language string

設定通知的語言。 可用值：en、、 etfidklvnonlisfrsedelt
自訂原因
 custom_reason string

自訂簽章原因。
頁面
 page string

可見 PDF 簽名註釋的頁面索引。 僅適用於PDF類型簽名。 預設值：1。
從上到下的位置
 top string

從頂部開始放置 （以點為單位） 以表示可見的 PDF 簽名註釋。 僅適用於PDF類型簽名。 預設值：1。
從左邊開始的位置
 left string

從左邊開始放置 （以點為單位） 以表示可見的 PDF 簽名註解。 僅適用於PDF類型簽名。 預設值：1。
語言
 language string

可見 PDF 簽名註釋的語言。 僅適用於PDF類型簽名。 可用值： en， ， lt， lvet，is

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。
簽署權杖
 token string

簽署權杖。
簽署者
 signers array of object

參與者的資訊。
外部 ID
 signers.external_id string

系統中參與者的唯一隨機識別碼。
代幣
 signers.token string

參與者的權杖。
名稱
 signers.first_name string

參與者的姓名。
Surname
 signers.last_name string

參與者的姓氏。
Code
 signers.code string

參與者的個人代碼（國民身份證號碼）。
國家
 signers.country string

參與者的國家/地區。
電子郵件
 signers.email string

參與者的電子郵件。

新增內部簽署者

作業識別碼：
DokobitUniversalAPIAddInternalSigner

指定的參與者將獲得具有所選角色的文件的存取權。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。
外部 ID
 external_id True string

系統中參與者的唯一隨機識別碼。 如果您沒有唯一的隨機識別碼，則可以產生唯一的隨機識別碼。
Role
 role string

參與者的角色。 可用值： signer， viewer. 預設值：signer。
Code
 code string

參與者的代碼。
國家代碼
 country_code string

參與者的國家/地區代碼。 如果提供個人代碼，則為必填。 可用值： LT、 LV、 EE、 IS、 SENOFIPLBE。
電話
 phone string

參與者的電話。
通知語言
 language string

設定使用者介面語言。 可用值：en、、 etfidklvnonlisfrsedelt
頁面
 page string

可見 PDF 簽名註釋的頁面索引。 僅適用於PDF類型簽名。 預設值：1。
從上到下的位置
 top string

從頂部開始放置 （以點為單位） 以表示可見的 PDF 簽名註釋。 僅適用於PDF類型簽名。 預設值：1。
從左邊開始的位置
 left string

從左邊開始放置 （以點為單位） 以表示可見的 PDF 簽名註解。 僅適用於PDF類型簽名。 預設值：1。
語言
 language string

可見 PDF 簽名註釋的語言。 僅適用於PDF類型簽名。 可用值： en， ， lt， lvet，is
自訂原因
 custom_reason string

自訂簽章原因。

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。
簽署者
 signers array of object

參與者的資訊。
外部 ID
 signers.external_id string

系統中參與者的唯一隨機識別碼。
代幣
 signers.token string

參與者的權杖。
名稱
 signers.name string

參與者的姓名。
Surname
 signers.surname string

參與者的姓氏。
電子郵件
 signers.email string

參與者的電子郵件。
Code
 signers.code string

參與者的個人代碼（國民身份證號碼）。
國碼 (地區碼)
 signers.country_code string

參與者的國家/地區。
Role
 signers.role string

參與者的角色。
公司
 signers.company string

參與者的公司。
Position
 signers.position string

參與者的立場。
電話
 signers.phone string

參與者的電話。

新增外部簽署者

作業識別碼：
DokobitUniversalAPIAddExternalSigner

指定的參與者將獲得具有所選角色的文件的存取權。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。
外部 ID
 external_id True string

系統中參與者的唯一隨機識別碼。 如果您沒有唯一的隨機識別碼，則可以產生唯一的隨機識別碼。
名稱
 name string

參與者的姓名。
Surname
 surname string

參與者的姓氏。
電子郵件
 email string

參與者的電子郵件。
Code
 code string

參與者的代碼。
國家代碼
 country_code string

參與者的國家/地區代碼。 如果提供個人代碼，則為必填。 可用值： LT， LV， EEBEISNOFI。 SE
Role
 role string

參與者的角色。 可用值： signer， viewer. 預設值：signer。
公司
 company string

參與者的公司。
Position
 position string

參與者的立場。
電話
 phone string

參與者的電話。
自訂原因
 custom_reason string

自訂簽章原因。
通知語言
 notifications_language string

設定通知的語言。 可用值：en、、 etfidklvnonlisfrsedelt
頁面
 page string

可見 PDF 簽名註釋的頁面索引。 僅適用於PDF類型簽名。 預設值：1。
從上到下的位置
 top string

從頂部開始放置 （以點為單位） 以表示可見的 PDF 簽名註釋。 僅適用於PDF類型簽名。 預設值：1。
從左邊開始的位置
 left string

從左邊開始放置 （以點為單位） 以表示可見的 PDF 簽名註解。 僅適用於PDF類型簽名。 預設值：1。
語言
 language string

可見 PDF 簽名註釋的語言。 僅適用於PDF類型簽名。 可用值： en， ， lt， lvet，is
評論
 comment string

給參與者的訊息。

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。
簽署者
 signers array of object

參與者的資訊。
外部 ID
 signers.external_id string

系統中參與者的唯一隨機識別碼。
代幣
 signers.token string

參與者的權杖。
名稱
 signers.name string

參與者的姓名。
Surname
 signers.surname string

參與者的姓氏。
電子郵件
 signers.email string

參與者的電子郵件。
Code
 signers.code string

參與者的個人代碼（國民身份證號碼）。
國碼 (地區碼)
 signers.country_code string

參與者的國家/地區。
Role
 signers.role string

參與者的角色。
公司
 signers.company string

參與者的公司。
Position
 signers.position string

參與者的立場。
通知語言
 signers.notifications_language string

設定通知的語言。 可用值：en、lt、islvetno'fr'、'se'、'de'。
電話
 signers.phone string

參與者的電話。

更新內部簽署

作業識別碼：
DokobitUniversalAPIUpdateInternalSigning

允許更新現有文件簽署的屬性。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。
需要合格的簽名
 require_qualified_signatures boolean

只允許使用合格的簽名進行簽名。 預設值：false。
允許視訊識別
 allow_video_identification boolean

允許使用基於視頻的識別進行簽名。 預設值：false。
允許的簽署方法
 allowed_signing_methods array of string

只允許特定的簽署方法。 可用值：mobile、、 eparaksts_mobileitsmeelectronic_ididinswisscomsmartcardbankid_sesms_otpbankid_noaudkenni_appftnmitidsmartid

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。

更新外部簽署

作業識別碼：
DokobitUniversalAPIUpdateExternalSigning

允許更新現有文件簽署的屬性。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。
Deadline
 deadline date-time

具有指定時區片段的簽署截止日期。 範例：2018-11-05T13：15：30Z。
硬性截止日期
 hard_deadline boolean

如果設定為 ， true 則在設定 deadline之後，參與者將無法簽署或核准此文件。 預設值：false。
需要合格的簽名
 require_qualified_signatures boolean

只允許使用合格的簽名進行簽名。 預設值：false。
允許視訊識別
 allow_video_identification boolean

允許使用基於視頻的識別進行簽名。 預設值：false。
允許儲存文件
 allow_document_saving boolean

允許用戶將文檔保存到 Dokobit 門戶並採取進一步操作。 預設值：true。
允許的簽署方法
 allowed_signing_methods array of string

只允許特定的簽署方法。 可用值：mobile、、 eparaksts_mobileitsmeelectronic_ididinswisscomsmartcardbankid_sesms_otpbankid_noaudkenni_appftnmitidsmartid

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。

檢查內部簽署狀態

作業識別碼：
DokobitUniversalAPICheckInternalSigningStatus

傳回具有簽署狀態的文件資訊。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。

傳回

名稱 路徑 類型 Description
簽署狀態
 status string

文件簽署狀態。
名稱
 name string

顯示使用者的簽署名稱。
類型
 type string

文件類型。
建立日期
 date_created string

起始文件簽署的日期。
Deadline
 deadline date-time

具有指定時區片段的簽署截止日期。 範例：2018-11-05T13：15：30Z。
檔案名稱
 filename string

檔案名稱。
檔案儲存體
 files array of object
名稱
 files.name string

檔案名稱。
下載網址
 files.url string

檔案下載 URL。
MIME 類型
 files.mime_type string

檔案 MIME 類型。
簽署者
 signers array of object

參與者資訊。
代幣
 signers.token string

參與者的權杖。
名稱
 signers.first_name string

參與者的姓名。
Surname
 signers.last_name string

參與者的姓氏。
Code
 signers.code string

參與者的代碼。
國家
 signers.country string

參與者的國家/地區。
電子郵件
 signers.email string

參與者的電子郵件。
類型
 signers.type string

類型。
地位
 signers.status string

參與者的狀態。

檢查外部簽署狀態

作業識別碼：
DokobitUniversalAPICheckExternalSigningStatus

傳回具有簽署狀態的文件資訊。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。

傳回

名稱 路徑 類型 Description
簽署狀態
 status string

文件簽署狀態。
名稱
 name string

顯示使用者的簽署名稱。
類型
 type string

文件類型。
建立日期
 date_created string

起始文件簽署的日期。
Deadline
 deadline date-time

具有指定時區片段的簽署截止日期。 範例：2018-11-05T13：15：30Z。
檔案名稱
 filename string

檔案名稱。
檔案儲存體
 files array of object
名稱
 files.name string

檔案名稱。
下載網址
 files.url string

檔案下載 URL。
MIME 類型
 files.mime_type string

檔案 MIME 類型。
簽署者
 signers array of object

參與者資訊。
代幣
 signers.token string

參與者的權杖。
名稱
 signers.first_name string

參與者的姓名。
Surname
 signers.last_name string

參與者的姓氏。
Code
 signers.code string

參與者的代碼。
國家
 signers.country string

參與者的國家/地區。
電子郵件
 signers.email string

參與者的電子郵件。
類型
 signers.type string

類型。
地位
 signers.status string

參與者的狀態。

發送提醒

作業識別碼：
DokobitUniversalAPIReminder

允許向參與者發送提醒電子郵件，僅當人員尚未簽署文檔時。 僅適用於外部簽署流程。

參數

名稱 機碼 必要 類型 Description
簽署權杖
 token True string

簽署權杖。
簽署者權杖
 signer True string

參與者的權杖。
Message
 message string

給簽署者的提醒訊息。

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。

電子送貨

作業識別碼：
DokobitUniversalAPIeDelivery

Document e-Delivery 用於與 Dokobit Universal API 安全地共享文檔。

參數

名稱 機碼 必要 類型 Description
類型
 type True string

文件格式。 可用值： pdf。
名稱
 name True string

顯示使用者的文件名稱。
回傳網址
 postback_url string

用於處理 Webhook 的系統 URL。
評論
 comment string

收件人的訊息。
名稱
 name True string

檔案名稱。
Content
 content True string

Base64 編碼的檔案內容。
外部 ID
 external_id True string

系統中參與者的唯一隨機識別碼。 如果您沒有唯一的隨機識別碼，則可以產生唯一的隨機識別碼。
Code
 code True string

收件人的個人代碼（國民身份證號碼）。
國碼 (地區碼)
 country_code True string

收件者的國家/地區代碼。 如果提供個人代碼，則為必填。 可用值： lt， ， ， ee。 islv
電子郵件
 email string

收件者傳送文件的電子郵件。 如果未設定電話，則為必要條件。
電話
 phone string

收件者用於傳送文件簡訊的電話號碼。 如果未設定電子郵件，則為必要。 只有在未提供電子郵件的情況下才會發送短信。
通知語言
 notifications_language string

設定通知的語言。 可用值：en、lt、islvetno'fr'、'se'、'de'。

傳回

名稱 路徑 類型 Description
地位
 status string

狀態。
文件權杖
 token string

文件權杖。
收件者
 recipients array of object

收件者資訊。
外部 ID
 recipients.external_id string

系統中參與者的唯一隨機識別碼。
代幣
 recipients.token string

收件者的權杖。
Code
 recipients.code string

收件人的個人代碼（國民身份證號碼）。
國家
 recipients.country string

收件者的國家/地區。
電子郵件
 recipients.email string

收件者的電子郵件。

驗證 - PDF 報告

作業識別碼：
DokobitUniversalAPIValidationPDFReport

下載 PDF 格式的驗證報告。

參數

名稱 機碼 必要 類型 Description
驗證權杖
 token True string

從 DokobitUniversalAPIValidation 動作收到的驗證權杖。

傳回

response
object

驗證 - XML 報告

作業識別碼：
DokobitUniversalAPIValidationXMLReport

下載 XML 格式的驗證報告。

參數

名稱 機碼 必要 類型 Description
驗證權杖
 token True string

從 DokobitUniversalAPIValidation 動作收到的驗證權杖。

傳回

response
object

驗證 - XML 診斷資料

作業識別碼：
DokobitUniversalAPIValidationXMLDiagnosticData

以 XML 下載診斷資料。

參數

名稱 機碼 必要 類型 Description
驗證權杖
 token True string

從 DokobitUniversalAPIValidation 動作收到的驗證權杖。

傳回

response
object

驗證 - 詳細的 PDF 報告

作業識別碼：
DokobitUniversalAPIValidationDetailedPDFReport

下載 PDF 格式的詳細驗證報告。

參數

名稱 機碼 必要 類型 Description
驗證權杖
 token True string

從 DokobitUniversalAPIValidation 動作收到的驗證權杖。

傳回

response
object

定義

物件

這是類型 'object'。