共用方式為

Taktikal Core （預覽版）

透過 Taktikal Core，您可以簽署、蓋章、驗證並取得有關簽署流程的詳細資訊。

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

服務 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://docs.taktikal.com/
Email help@taktikal.com
連接器中繼資料
Publisher 塔克蒂卡爾
網站 https://taktikal.com/
隱私策略 https://www.taktikal.com/privacy
類別 生產力

Taktikal Core API 是一種強大的方式，可以在您自己的介面中建置新解決方案，並與已在運作的解決方案整合。

文件可以直接從您自己的系統發送以供簽名，簽名後，文件和相關元資料可以自動發送回文件系統。 您也可以監控簽署過程中文件的狀態，並根據身分證號碼或其他唯一識別碼呼叫狀態。

先決條件

若要使用 Taktikal Core API，請聯絡我們的銷售團隊 sales@taktikal.is ，以取得必要的 API 憑證。

如何取得認證

請聯絡我們的銷售團隊以建立存取權限並取得您的 API 憑證。

開始使用連接器

核心 API 可以簽署文件、使用冰島 e-ID 進行身份驗證並管理所有簽署流程

  • 對於身份驗證，請使用 /Auth/Start 啟動身份驗證過程，然後使用 /Auth/Poll 檢查身份驗證的狀態。
  • 若要簽署單一文件，請呼叫 /management/signed 以取得單一文件，並呼叫 /management/signing/sequential 以取得多個文件的大量簽署。
  • 若要取得簽署程式的詳細記錄，請呼叫 /signing/activity/{ProcessKey}。

已知問題與限制

  • 請求需要具有基本身份驗證的授權標頭。那就是公司的關鍵和 API-Key
  • 目前，只有合格簽名帶有冰島電子身份證。
  • 提供的 PDF 應該是 ab Base64 字串。
  • 簽署人必須擁有有效的電子郵件和行動電話號碼。

常見錯誤和補救措施

目前只接受 PDF 簽名。

FAQ

如需有關API的詳細資訊，請參閱 https://docs.taktikal.com

啟動簽署程式是單一 POST 要求。 若要開始簽署程序，需要有效的 PDF 文件，以及需要簽署文件的簽署者清單。 Taktikal 將處理向簽署者顯示文件，如果選取了 communicationDeliveryType，Taktikal 將向簽署者發送帶有簽名連結的簡訊或電子郵件。 文件由所有參與者簽署後，Taktikal 會將文件發送到註冊的相關交付路徑。

flowKey 是 Taktikal 提供的金鑰。 此金鑰將告訴 Taktikal 如何處理此請求。 對於某些 flowKey，Taktikal 將負責建立文件。 它還將控制簽名文件在簽署後的交付位置。

正在建立連線

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

預設

適用：所有地區

建立連線的參數。

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

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

節流限制

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

動作

使用冰島 e-id 啟動身份驗證過程

可以使用手機或 Audkenni 應用程序使用冰島 e-id 進行身份驗證。

  • 使用手機：AuthenticationContextType 應設定為 'Sim'，且 phoneNumber 必須設定為冰島手機號碼。 ssn 會被忽略。
  • 使用 Audkenni 應用程式：AuthenticationContextType 應設定為「App」，且 ssn 必須設定為 Icdlandic 社會安全號碼。 電話號碼會被忽略。

應始終提供 flowKey，並且可在 Taktikal 門戶中訪問。
使用冰島語 e-id 啟動身份驗證程序，以進行順序簽名程序

可以使用手機或 Audkenni 應用程序使用冰島 e-id 進行身份驗證。

  • 使用行動電話：AuthenticationContextType 應設定為 'Sim'，且 phoneNumber 必須設定為 Ucelandic 行動電話號碼。 ssn 會被忽略。
  • 使用 Audkenni 應用程式：AuthenticationContextType 應設定為「App」，且 ssn 必須設定為 Icdlandic 社會安全號碼。 電話號碼會被忽略。
取得 processKey 和 signeeKey 的簽署程式

通過 processkey 和 signeeKey 獲取簽名過程。
取得公司的活動記錄

取得公司的活動記錄
取得特定期間使用者 （電子郵件） 的活動記錄

取得使用者一段時間的活動記錄。
取得簽署程式的活動記錄檔

取得簽署程式的活動記錄檔。
取消循序簽署程序

取消基於給定序列索引鍵的循序簽署程序。 可以提供取消循序程序的使用者 （電子郵件）。
取消簽署程序

取消針對指定程序索引鍵的簽署程序。
密封 PDF 文件

密封以 base64 字串形式提供的 PDF 文件。
密封 XML 文件

密封以 base64 字串形式提供的 XML 文件。
建立具有一或多個簽署者的新簽署程序

建立新的簽署程序，其中包含一或多個簽署者。
建立新的循序 （大量） 簽署程序

建立具有一或多個簽署程序的新循序簽署程序 （大量）。 序列中的每個簽署程序都有一或多個簽署者。

範例：

  • 一家公司希望簽署文件 A 和 B。 簽署人 X 應簽署文件 A 和 B，簽署人 Y 應簽署文件 A，簽署人 Z 應簽署文件 B。
  • 然後是新的 CreateSequentalSigning，其中包含兩個 CreateSigningProcess 物件的陣列。 簽署者 X 和 Y 會新增為文件 A 的 CreateSigningProcess 的簽署者，而簽署者 X 和 Z 會新增為文件 B 的簽署者。

詳細文件可以在 https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/
更新指定 ProcessKey 和 SigneeKey 的簽署者

簽署者屬性可以根據提供 ProcessKey 和 SigneeKey 來更新。
檢查使用其冰島 e-id 的使用者的身份驗證狀態

從 /Auth/Start 成功回應之後，會傳回 AuthRequestId，並用來檢查驗證是否已完成。 如果驗證完成且成功，則會根據 LookupType 填入客戶物件。 查閱類型表示為冰島國家登記處擷取的資訊類型。

根據 LookupType，會傳回三種不同的資料集：

  1. 名稱：只會傳回已驗證人員的 SSN 和名稱。 這沒有額外的查詢成本。

  2. NameAddress：將傳回名稱、SSN 和地址資訊。 這會產生額外的查詢成本。 如果未為 LookupType 提供值，則這是預設值。

  3. NameAddressFamily：傳回名稱、SSN、地址資料、性別代碼和家庭資訊。

如果選取 'LookupType.NameAddressFamily'，則傳回的額外值將會傳回 'Meta'。

如果回應有錯誤或未完成，客戶物件將會是 Null，而 StatusMessage 會有詳細訊息。

使用冰島 e-id 啟動身份驗證過程

作業識別碼：
AuthStartStart_Post

可以使用手機或 Audkenni 應用程序使用冰島 e-id 進行身份驗證。

  • 使用手機：AuthenticationContextType 應設定為 'Sim'，且 phoneNumber 必須設定為冰島手機號碼。 ssn 會被忽略。
  • 使用 Audkenni 應用程式：AuthenticationContextType 應設定為「App」，且 ssn 必須設定為 Icdlandic 社會安全號碼。 電話號碼會被忽略。

應始終提供 flowKey，並且可在 Taktikal 門戶中訪問。

參數

名稱 機碼 必要 類型 Description
社會安全號碼
 ssn string
電話號碼
 phoneNumber string
flowKey
 flowKey True string

屬於公司之流程的唯一識別碼。
authenticationContextType
 authenticationContextType True string

傳回

啟動驗證回應

啟動驗證回應
StartAuthResponse

使用冰島語 e-id 啟動身份驗證程序，以進行順序簽名程序

作業識別碼：
RequestToViewSequenceStartsequentialSequenceKeyauth_Post

可以使用手機或 Audkenni 應用程序使用冰島 e-id 進行身份驗證。

  • 使用行動電話：AuthenticationContextType 應設定為 'Sim'，且 phoneNumber 必須設定為 Ucelandic 行動電話號碼。 ssn 會被忽略。
  • 使用 Audkenni 應用程式：AuthenticationContextType 應設定為「App」，且 ssn 必須設定為 Icdlandic 社會安全號碼。 電話號碼會被忽略。

參數

名稱 機碼 必要 類型 Description
序列 （大量） 簽署程序的唯一識別碼。
 SequenceKey True string

序列 （大量） 簽署程序的唯一識別碼。
sequenceKey
 sequenceKey True string
登入提示
 loginHint True string
authenticationContextType
 authenticationContextType True string

傳回

啟動驗證回應

啟動驗證回應
StartAuthResponse

取得 processKey 和 signeeKey 的簽署程式

作業識別碼：
GetSigningProcessBySigneeProcessKeysigneeSigneeKey_Get

通過 processkey 和 signeeKey 獲取簽名過程。

參數

名稱 機碼 必要 類型 Description
單一文件簽署程序的唯一識別碼。
 ProcessKey True string

單一文件簽署程序的唯一識別碼。
簽署單一簽署程序的人員的唯一識別碼。
 SigneeKey True string

簽署單一簽署程序的人員的唯一識別碼。
使用者代理程式是代表使用者運作的軟體，例如 Web 瀏覽器或電子郵件用戶端。
 UserAgent string

使用者代理程式是代表使用者運作的軟體，例如 Web 瀏覽器或電子郵件用戶端。

傳回

簽署流程

簽署流程
SigningProcess

取得公司的活動記錄

作業識別碼：
GetSigningProcessActivityByCompanyactivitycompany_Get

取得公司的活動記錄

參數

名稱 機碼 必要 類型 Description
要搜尋的記錄的開始日期必須小於 EndDate 的日期。
 StartDate True date-time

要搜尋的記錄的開始日期必須小於 EndDate 的日期。
要搜尋的記錄的結束日期，必須大於 StartDate 的日期。
 EndDate True date-time

要搜尋的記錄的結束日期，必須大於 StartDate 的日期。
用於分頁結果集，只傳回 N 個結果。
 Take integer

用於分頁結果集，只傳回 N 個結果。
用於分頁結果集並略過前 N 個結果。
 Skip integer

用於分頁結果集並略過前 N 個結果。
用戶的電子郵件。
 User string

用戶的電子郵件。
可用於僅取得特定流程類型的活動。
 FlowType string

可用於僅取得特定流程類型的活動。
如果它有一個值，我們只會傳回符合此 flowKey 的記錄。
 FlowKey string

如果它有一個值，我們只會傳回符合此 flowKey 的記錄。

傳回

目錄<SigningProcessActivityLogWrapper>
array of SigningProcessActivityLogWrapper

取得特定期間使用者 （電子郵件） 的活動記錄

作業識別碼：
GetSigningProcessActivityForUseractivityuser_Get

取得使用者一段時間的活動記錄。

參數

名稱 機碼 必要 類型 Description
用戶的電子郵件。
 User string

用戶的電子郵件。
要搜尋的記錄的開始日期必須小於 EndDate 的日期。
 StartDate True date-time

要搜尋的記錄的開始日期必須小於 EndDate 的日期。
要搜尋的記錄的結束日期，必須大於 StartDate 的日期。
 EndDate True date-time

要搜尋的記錄的結束日期，必須大於 StartDate 的日期。
使用 if 在單一簽署程式上進行篩選。
 ProcessKey string

使用 if 在單一簽署程式上進行篩選。
可用於僅取得特定流程類型的活動。
 FlowType string

可用於僅取得特定流程類型的活動。
用於分頁結果集，只傳回 N 個結果。
 Take integer

用於分頁結果集，只傳回 N 個結果。
用於分頁結果集並略過前 N 個結果。
 Skip integer

用於分頁結果集並略過前 N 個結果。
如果它有一個值，我們只會傳回符合此 flowKey 的記錄
 FlowKey string

如果它有一個值，我們只會傳回符合此 flowKey 的記錄。

傳回

目錄<SigningProcessActivityLogWrapper>
array of SigningProcessActivityLogWrapper

取得簽署程式的活動記錄檔

作業識別碼：
GetSigningProcessActivityactivityProcessKey_Get

取得簽署程式的活動記錄檔。

參數

名稱 機碼 必要 類型 Description
用戶的電子郵件。
 User string

用戶的電子郵件。
要搜尋的記錄的開始日期必須小於 EndDate 的日期。
 StartDate True date-time

要搜尋的記錄的開始日期必須小於 EndDate 的日期。
要搜尋的記錄的結束日期，必須大於 StartDate 的日期。
 EndDate True date-time

要搜尋的記錄的結束日期，必須大於 StartDate 的日期。
使用 if 在單一簽署程式上進行篩選。
 ProcessKey True string

使用 if 在單一簽署程式上進行篩選。
可用於僅取得特定流程類型的活動。
 FlowType string

可用於僅取得特定流程類型的活動。
用於對結果集進行分頁，並且只傳回N個結果。
 Take integer

用於對結果集進行分頁，並且只傳回N個結果。
用於分頁結果集並跳過前 N 個結果。
 Skip integer

用於分頁結果集並跳過前 N 個結果。
如果它有一個值，我們只會傳回符合此 flowKey 的記錄。
 FlowKey string

如果它有一個值，我們只會傳回符合此 flowKey 的記錄。

傳回

目錄<SigningProcessActivityLogWrapper>
array of SigningProcessActivityLogWrapper

取消循序簽署程序

作業識別碼：
CancelSequenceSigningsigningsequential_Delete

取消基於給定序列索引鍵的循序簽署程序。 可以提供取消循序程序的使用者 （電子郵件）。

參數

名稱 機碼 必要 類型 Description
必須提供的循序簽署程序識別碼。
 SequenceKey True string

必須提供的循序簽署程序識別碼。
只有啟動簽署程序的使用者才能取消它。
 User True string

只有啟動簽署程序的使用者才能取消它。

傳回

循序簽署

循序簽署
SequentialSigning

取消簽署程序

作業識別碼：
CancelSigningProcesssigning_Delete

取消針對指定程序索引鍵的簽署程序。

參數

名稱 機碼 必要 類型 Description
單一文件簽署程序的唯一識別碼。
 ProcessKey string

單一文件簽署程序的唯一識別碼。
String 物件，通常是有權存取入口網站的員工的電子郵件。
 User string

String 物件，通常是有權存取入口網站的員工的電子郵件。

傳回

簽署流程

簽署流程
SigningProcess

密封 PDF 文件

作業識別碼：
SealingRequestsealing_Post

密封以 base64 字串形式提供的 PDF 文件。

參數

名稱 機碼 必要 類型 Description
pdf文件
 pdfDocument True string

要密封的 PDF 文件的 Base64String。
flowKey
 flowKey True string

屬於公司之流程的唯一識別碼。
reason
 reason string

設定要在印章中顯示的原因
語言類型
 languageType string

傳回

SealingResponse

SealingResponse
SealingResponse

密封 XML 文件

作業識別碼：
SealingXmlRequestsealingxml_Post

密封以 base64 字串形式提供的 XML 文件。

參數

名稱 機碼 必要 類型 Description
xml文件
 xmlDocument True string

Base64要密封的 XML 文件的字串
flowKey
 flowKey True string

Taktikal 提供的有效 flowKey，可用於密封

傳回

物體

response
object

建立具有一或多個簽署者的新簽署程序

作業識別碼：
CreateSigningProcesssigning_Post

建立新的簽署程序，其中包含一或多個簽署者。

參數

名稱 機碼 必要 類型 Description
pdf文件
 pdfDocument string

是要簽署之文件的 base64 字串。 如果 flowKey 負責建立文件，則不需要這樣做。
pdf檔案名稱
 pdfFileName string

如果使用 PdfDocument，則需要提供檔案名稱的值。
flowKey
 flowKey True string

FlowKey 由 Taktikal 提供。 此金鑰將告訴 Taktikal 如何處理此請求。 對於某些 flowKey，Taktikal 將負責建立文件。 它還將控制簽名文件在簽署後的交付位置。
processKey
 processKey string
名稱
 name string
社會安全號碼
 ssn string
電話號碼
 phoneNumber string
電子郵件
 email string
address
 address string
postalCode
 postalCode string
city
 city string
reason
 reason string
隱藏個人代碼
 hidePersonalCode boolean
通訊傳遞類型
 communicationDeliveryType string
自訂簡訊文字
 customSmsText string
signatureType
 signatureType string
語言
 language string
字典
 meta object

字典<字串，字串>
fileName
 fileName string
檔案內容
 fileContent string
識別碼
 id string
fileName
 fileName string
內容長度
 contentLength integer
內容類型
 contentType string
url
 url string
說明
 description string
processKey
 processKey string
attachmentType
 attachmentType string
signeeKey
 signeeKey string
requiresAuth
 requiresAuth boolean

預設值為 False。 如果設定為 true，則所有簽署者都需要使用該 e-ID 進行驗證，才能檢視文件。
signInOrder
 signInOrder boolean

預設值為 False。 將控制簽名者的順序。 它只會向簽署者清單中的第一個人發送簽名請求。 在他簽下下一個簽約者之後，依此類推。
signature位置
 signatureLocation string

可以是 BottomLastPage 或預設值 TopFirstPage。 將控制在文件中顯示簽名的位置。
使用者
 user string

傳送要求之使用者的電子郵件地址。 可以是空的。
sequenceKey
 sequenceKey string
activityDisplayName
 activityDisplayName string
平面化文件
 flattenDocument boolean

預設值為 False。 如果設定為 true，我們將嘗試平面化文件輸入欄位。
提醒規則
 reminderRule string

發送提醒，不留空。 格式應為“firstReminder after x days：Then every y days”，例如“1：3”將在 1 天后發送一次提醒，之後每三天發送一次提醒。 為空或空表示無提醒，有效值將在 0-30 天之間發送第一個提醒（0 表示沒有提醒），然後每 0-15 天發送一次（0，同樣，表示沒有提醒，因此 0：10 只會每 10 天發送一次提醒，而 12：0 只會在 12 天後發送一次提醒

傳回

簽署流程

簽署流程
SigningProcess

建立新的循序 （大量） 簽署程序

作業識別碼：
CreateSequentialSigningsigningsequential_Post

建立具有一或多個簽署程序的新循序簽署程序 （大量）。 序列中的每個簽署程序都有一或多個簽署者。

範例：

  • 一家公司希望簽署文件 A 和 B。 簽署人 X 應簽署文件 A 和 B，簽署人 Y 應簽署文件 A，簽署人 Z 應簽署文件 B。
  • 然後是新的 CreateSequentalSigning，其中包含兩個 CreateSigningProcess 物件的陣列。 簽署者 X 和 Y 會新增為文件 A 的 CreateSigningProcess 的簽署者，而簽署者 X 和 Z 會新增為文件 B 的簽署者。

詳細文件可以在 https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/

參數

名稱 機碼 必要 類型 Description
pdf文件
 pdfDocument string

是要簽署之文件的 base64 字串。 如果 flowKey 負責建立文件，則不需要這樣做。
pdf檔案名稱
 pdfFileName string

如果使用 PdfDocument，則需要提供檔案名稱的值。
flowKey
 flowKey True string

FlowKey 由 Taktikal 提供。 此金鑰將告訴 Taktikal 如何處理此請求。 對於某些 flowKey，Taktikal 將負責建立文件。 它還將控制簽名文件在簽署後的交付位置。
processKey
 processKey string
名稱
 name string
社會安全號碼
 ssn string
電話號碼
 phoneNumber string
電子郵件
 email string
address
 address string
postalCode
 postalCode string
city
 city string
reason
 reason string
隱藏個人代碼
 hidePersonalCode boolean
通訊傳遞類型
 communicationDeliveryType string
自訂簡訊文字
 customSmsText string
signatureType
 signatureType string
語言
 language string
字典
 meta object

字典<字串，字串>
fileName
 fileName string
檔案內容
 fileContent string
識別碼
 id string
fileName
 fileName string
內容長度
 contentLength integer
內容類型
 contentType string
url
 url string
說明
 description string
processKey
 processKey string
attachmentType
 attachmentType string
signeeKey
 signeeKey string
requiresAuth
 requiresAuth boolean

預設值為 False。 如果設定為 true，則所有簽署者都需要使用該 e-ID 進行驗證，才能檢視文件。
signInOrder
 signInOrder boolean

預設值為 False。 將控制簽名者的順序。 它只會向簽署者清單中的第一個人發送簽名請求。 在他簽下下一個簽約者之後，依此類推。
signature位置
 signatureLocation string

可以是 BottomLastPage 或預設值 TopFirstPage。 將控制在文件中顯示簽名的位置。
使用者
 user string

傳送要求之使用者的電子郵件地址。 可以是空的。
sequenceKey
 sequenceKey string
activityDisplayName
 activityDisplayName string
平面化文件
 flattenDocument boolean

預設值為 False。 如果設定為 true，我們將嘗試平面化文件輸入欄位。
提醒規則
 reminderRule string

發送提醒，不留空。 格式應為“firstReminder after x days：Then every y days”，例如“1：3”將在 1 天后發送一次提醒，之後每三天發送一次提醒。 為空或空表示無提醒，有效值將在 0-30 天之間發送第一個提醒（0 表示沒有提醒），然後每 0-15 天發送一次（0，同樣，表示沒有提醒，因此 0：10 只會每 10 天發送一次提醒，而 12：0 只會在 12 天後發送一次提醒
使用者
 user True string

啟動循序簽署程序的使用者
requiresAuth
 requiresAuth boolean

預設值為 False。 如果設定為 true，則所有簽署者都需要使用該 e-ID 進行驗證，才能檢視文件。
signInOrder
 signInOrder boolean

預設值為 False。 將控制簽名者的順序。 它只會向簽署者清單中的第一個人發送簽名請求。 在他簽下下一個簽約者之後，依此類推。

傳回

循序簽署

循序簽署
SequentialSigning

更新指定 ProcessKey 和 SigneeKey 的簽署者

作業識別碼：
UpdateSigneeProcessKeysigneeSigneeKey_Create

簽署者屬性可以根據提供 ProcessKey 和 SigneeKey 來更新。

參數

名稱 機碼 必要 類型 Description
簽署單一簽署程序的人員的唯一識別碼。
 SigneeKey True string

簽署單一簽署程序的人員的唯一識別碼。
單一文件簽署程序的唯一識別碼。
 ProcessKey True string

單一文件簽署程序的唯一識別碼。
電子郵件
 email string
address
 address string
postalCode
 postalCode string
city
 city string
signeeKey
 signeeKey True string
processKey
 processKey True string
reason
 reason string
使用者
 user string

傳回

簽署者

簽署者
Signee

檢查使用其冰島 e-id 的使用者的身份驗證狀態

作業識別碼：
AuthPollPoll_Post

從 /Auth/Start 成功回應之後，會傳回 AuthRequestId，並用來檢查驗證是否已完成。 如果驗證完成且成功，則會根據 LookupType 填入客戶物件。 查閱類型表示為冰島國家登記處擷取的資訊類型。

根據 LookupType，會傳回三種不同的資料集：

  1. 名稱：只會傳回已驗證人員的 SSN 和名稱。 這沒有額外的查詢成本。

  2. NameAddress：將傳回名稱、SSN 和地址資訊。 這會產生額外的查詢成本。 如果未為 LookupType 提供值，則這是預設值。

  3. NameAddressFamily：傳回名稱、SSN、地址資料、性別代碼和家庭資訊。

如果選取 'LookupType.NameAddressFamily'，則傳回的額外值將會傳回 'Meta'。

如果回應有錯誤或未完成，客戶物件將會是 Null，而 StatusMessage 會有詳細訊息。

參數

名稱 機碼 必要 類型 Description
authRequestId
 authRequestId True string
flowKey
 flowKey True string

屬於公司之流程的唯一識別碼。
lookup類型
 lookupType True string

傳回

民意調查客戶

民意調查客戶
PollCustomer

定義

簽署者

簽署者

名稱 路徑 類型 Description
名稱
 name string
社會安全號碼
 ssn string
電話號碼
 phoneNumber string
電子郵件
 email string
address
 address string
postalCode
 postalCode string
city
 city string
Key
 key string
簽名
 signed boolean
signed在
 signedAt date-time
processKey
 processKey string
reason
 reason string
隱藏個人代碼
 hidePersonalCode boolean
通訊傳遞類型
 communicationDeliveryType string
url
 url string
signatureType
 signatureType string
語言
 language string
自訂簡訊文字
 customSmsText string

簽署附件

簽署附件

名稱 路徑 類型 Description
fileName
 fileName string
檔案內容
 fileContent string

附件參考

附件參考

名稱 路徑 類型 Description
識別碼
 id string
fileName
 fileName string
內容長度
 contentLength integer
內容類型
 contentType string
url
 url string
說明
 description string
processKey
 processKey string
attachmentType
 attachmentType string
signeeKey
 signeeKey string

Dictionary_String_String_

字典<字串，字串>

名稱 路徑 類型 Description
字典
 object

字典<字串，字串>

SigningProcessActivityLog包裝函式

SigningProcessActivityLog包裝函式

名稱 路徑 類型 Description
processKey
 processKey string
活動日誌
 activityLog array of SigningProcessActivityLog
簽約者
 signees array of SigneeActivityLog
序列簽署者
 sequenceSignees array of SequentialSigningSigneeActivityLog
附件參考
 attachmentReferences array of AttachmentReference
activityDisplayName
 activityDisplayName string

簽署程序活動日誌

簽署程序活動日誌

名稱 路徑 類型 Description
flowKey
 flowKey string

屬於公司之流程的唯一識別碼。
processKey
 processKey string
signeeKey
 signeeKey string
狀態
 status string
說明
 description string
userAgent
 userAgent string
fileName
 fileName string
創建於
 createdAt date-time
由...創建
 createdBy string
requiresAuth
 requiresAuth boolean
signInOrder
 signInOrder boolean
signature位置
 signatureLocation string
sequenceKey
 sequenceKey string

簽署者活動日誌

簽署者活動日誌

名稱 路徑 類型 Description
processKey
 processKey string
signeeKey
 signeeKey string
社會安全號碼
 ssn string
名稱
 name string
address
 address string
postalCode
 postalCode string
city
 city string
phone
 phone string
電子郵件
 email string
創建於
 createdAt date-time
由...創建
 createdBy string
updatedAt
 updatedAt date-time
signatureType
 signatureType string

SequentialSigningSigneeActivityLog

SequentialSigningSigneeActivityLog

名稱 路徑 類型 Description
sequenceKey
 sequenceKey string
signeeKey
 signeeKey string
url
 url string
簽署金鑰
 signingKeys array of SigneeKeys

簽字者金鑰

簽字者金鑰

名稱 路徑 類型 Description
signeeKey
 signeeKey string
processKey
 processKey string

循序簽署

循序簽署

名稱 路徑 類型 Description
Key
 key string
狀態
 status string
requiresAuth
 requiresAuth boolean
使用者
 user string
signInOrder
 signInOrder boolean
簽約者
 signees array of SequentialSigningSignee
簽署程序
 signingProcesses array of SigningProcess

循序簽署簽章者

循序簽署簽章者

名稱 路徑 類型 Description
Key
 key string
url
 url string
簽署金鑰
 signingKeys array of SigneeKeys

簽署流程

簽署流程

名稱 路徑 類型 Description
Key
 key string
簽約者
 signees array of Signee
flowKey
 flowKey string

屬於公司之流程的唯一識別碼。
狀態
 status string
字典
 meta Dictionary_String_String_

字典<字串，字串>
pdf檔案名稱
 pdfFileName string
attachments
 attachments array of SigningAttachment
附件參考
 attachmentReferences array of AttachmentReference
requiresAuth
 requiresAuth boolean
使用者
 user string
signInOrder
 signInOrder boolean
signature位置
 signatureLocation string
sequenceKey
 sequenceKey string
平面化文件
 flattenDocument boolean

啟動驗證回應

啟動驗證回應

名稱 路徑 類型 Description
authRequestId
 authRequestId string
驗證代碼
 verificationCode string

SealingResponse

SealingResponse

名稱 路徑 類型 Description
pdf文件
 pdfDocument string

客戶

客戶

名稱 路徑 類型 Description
名稱
 name string
社會安全號碼
 ssn string
電話號碼
 phoneNumber string
電子郵件
 email string
address
 address string
postalCode
 postalCode string
city
 city string
Token
 token string
flowKey
 flowKey string

屬於公司之流程的唯一識別碼。
字典
 meta Dictionary_String_String_

字典<字串，字串>

民意調查客戶

民意調查客戶

名稱 路徑 類型 Description
客戶
 customer Customer

客戶
statusMessage
 statusMessage string
waitingForUser輸入
 waitingForUserInput boolean

物件

這是類型 'object'。