共用方式為

Legalesign （預覽版）

Legalesign 的連接器專為注重合規性的法律和營運團隊而設計，將 Microsoft Power Platform 與 Legalesign 電子簽名連結起來，以觸發文件和收件者工作流程、發送提醒、獲取 PDF 和顯示表單資料。 需要有效的 Legalesign 訂閱，並核准使用 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）
連絡人​​
名稱 API 支援
URL https://legalesign.com/contact/
Email sales@legalesign.com
連接器中繼資料
Publisher 法律標誌
進一步了解 Legalesign https://docs.microsoft.com/connectors/legalesign
網站 https://legalesign.com
隱私政策 https://legalesign.com/opn/privacy/
類別 內容和文件;生產力

Legalesign eSignature REST 連接器

Legalesign REST API 為電子簽章工作流程提供支援。 此連接器提供完整的 API 存取和即時觸發器，可與 Microsoft Power Automate、邏輯應用程式和相關平台無縫整合。

先決條件

首先，您需要一個 Legalesign 帳戶和 API 金鑰：1. 註冊 免費試用。 2. 建立群組 （個別環境，例如，一個用於開發，另一個用於生產環境）。 3. 透過建立支援票證來請求 API 金鑰。 包含您的使用案例、公司和角色，以便支援人員可以驗證您的身分。 4. 驗證後，登入 API 儀表板 以檢索您的金鑰。

部署

新帳戶會以沙箱模式啟動，但有下列限制：• 文件只能傳送至您在 API 儀表板中設定的測試電子郵件地址。 • 請求被限制為 100/分鐘。

當您準備好上線時， 請建立支援票證 ，以將您的帳戶從沙箱切換至生產環境。 屆時，限制將被取消。 如需詳細資訊，請參閱 部署指南 。

觸發器

連接器支援兩個即時觸發程式：

  • 文件事件 （例如，建立、拒絕、簽署、建立最終 PDF）
  • 收件者事件（例如，已完成、已拒絕、電子郵件已開啟、退回、已傳送提醒）

您可以接收依群組或事件類型篩選的所有文件或收件者。 所有關聯的 Legalesign Webhook 都可以在 API 儀表板中管理和監控。

Operations

支援 Legalesign REST API 作業。 最常見的包括下載已簽署的 PDF、管理範本、文件、收件者和欄位放置。 如需完整規格，請參閱 完整的 API 文件 。

在 Legalesign 中，上傳的文件稱為「範本」。 當範本傳送給一或多個收件者時，它會變成「檔案」。 您通常會上傳範本，復原其識別碼，然後將其傳送給一或多個收件者。

常見的操作包括：

範本

  • Create PDF template - 上傳範本 （任何檔案類型，例如 PDF、Word 或影像）。
  • Get PDF embeddable link - 向使用者顯示範本編輯器的一次性連結

Documents

  • Location to download PDF - 傳回已簽署文件的 PDF 二進位檔
  • Create signing document - 傳送文件 （選取範本和收件者）
  • Void/archive signing document - 停止簽署文件
  • Permanently delete signing document - 永久刪除文檔

收件者 （簽署者）

  • Send signer reminder email - 提醒收件人完成您的文件
  • Get signer rejection reason - 如果文件被拒絕，請參閱原因

外地安置

Legalesign 具有帶有字段的高級表單系統。 如果您有簽章人，則每個簽章人必須至少有一個簽章欄位。

有四種方式可以在範本中定義欄位：

  1. 上傳包含內嵌欄位的 PDF（由 Legalesign 自動轉換）。
  2. 使用 Legalesign 文字標籤。
  3. 定義 x/y 座標。
  4. 使用 Legalesign 表單編輯器（透過嵌入連結或 Web 應用程式）。

點擊此處查看指南

查詢和支持

如需其他支援或查詢，請登入您的 Legalesign 帳戶並 建立支援票證。

建立連線

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

預設

適用：所有地區

建立連線的參數。

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

名稱 類型 Description 為必填項目
API 密鑰 (api_key) securestring 此 API 的api_key 對

節流限制

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

動作

上傳 PDF 範本

上傳您要傳送以供簽署的 PDF 文件。
上傳 PDF 附件

儲存 pdf 以附加到收件者電子郵件。
下載 PDF

根據簽署文件的狀態，取得簽署文件的草稿或最終 PDF。 請注意，200 或 302 回應是可能的。
下載文件稽核日誌

僅文件審核日誌的 PDF。
作廢並封存文件

設定狀態為 40 -已移除 - 的文件並將其封存。
傳送收件者提醒電子郵件

傳送提醒電子郵件給收件者。
傳送文件

傳送文件以供簽署或核准。
刪除附件

刪除附件。
取得 PDF 可嵌入連結

傳回內嵌 PDF 編輯器的一次性連結。
取得 PDF 範本

列出 PDF 範本
取得使用者

取得使用者詳細資料。
取得收件者

取得個別收件者的狀態和詳細資料。
取得收件者拒絕原因

傳回簽署者拒絕文件的原因。
取得收件者表單欄位

傳回特定收件者的表單欄位。
取得收件者連結

收件人前往簽名頁面的一次性鏈接。
取得文件

傳回特定文件。
取得文件

列出未存檔的簽署文件。
取得文件欄位

文件中的欄位。
取得群組

列出 API 使用者所屬的群組。
取得附件

列出附件。
永久刪除文件

永久刪除資料和檔案。
獲取 PDF 模板

特定 PDF 範本的詳細資料
獲取依戀

取得附件。
群組成員

群組內特定使用者的詳細資料。
群組成員

您群組所有成員的清單。

上傳 PDF 範本

作業識別碼：
PostPdfTemplate

上傳您要傳送以供簽署的 PDF 文件。

參數

名稱 機碼 必要 類型 Description
發送時存檔
 archive_upon_send boolean

如果此上傳僅供一次性使用，請設定 true。
群體
 group True string

指定將使用此專案的群組。
PDF檔案
 pdf_file True byte

Base64 編碼的 PDF 文件數據。
處理標籤
 process_tags boolean

如果檔案包含文字標籤，請將其轉換為欄位。
Title
 title string

命名此記錄，如果不使用，將使用檔案名稱。
User
 user string

如果不是 api 用戶，則分配給組成員。

上傳 PDF 附件

作業識別碼：
PostAttachment

儲存 pdf 以附加到收件者電子郵件。

參數

名稱 機碼 必要 類型 Description
組成群組
 group True string

群組資源 uri
pdf_file
 pdf_file True byte

Base64編碼的PDF檔案數據，最大大小為群組設置，預設為5MB。
filename
 filename True string

簡單的英數字元名稱結尾 .pdf
使用者
 user string

指派給其他使用者。
description
 description string

下載 PDF

作業識別碼：
GetDocumentPdf

根據簽署文件的狀態，取得簽署文件的草稿或最終 PDF。 請注意，200 或 302 回應是可能的。

參數

名稱 機碼 必要 類型 Description
文件標識碼
 docId True uuid

文件標識碼

傳回

response
file

下載文件稽核日誌

作業識別碼：
GetDocumentAuditLog

僅文件審核日誌的 PDF。

參數

名稱 機碼 必要 類型 Description
文件標識碼
 docId True uuid

文件標識碼

傳回

response
file

作廢並封存文件

作業識別碼：
UpdateArchiveDocument

設定狀態為 40 -已移除 - 的文件並將其封存。

參數

名稱 機碼 必要 類型 Description
文件標識碼
 docId True uuid

文件標識碼
向收件人發送通知電子郵件
 email string

如果設定為 true 或 1，則收件者會收到通知，文件會作廢。

傳送收件者提醒電子郵件

作業識別碼：
PostSignerReminder

傳送提醒電子郵件給收件者。

參數

名稱 機碼 必要 類型 Description
收件者 ID
 recipientId True uuid

收件者 ID
收發簡訊
 text string

自訂訊息文字

傳送文件

作業識別碼：
PostDocument

傳送文件以供簽署或核准。

參數

名稱 機碼 必要 類型 Description
群體
 group True string

群組資源 uri
名稱
 name True string

指定文件的名稱
PDF模板
 templatepdf True string

上傳的 PDF 要傳送。
電子郵件
 email True email

Email
名字
 firstname True string

名字
姓氏
 lastname True string

姓氏
attachments
 attachments array of string

附件資源 URI 清單。
過期
 expires date-time

ISO8601形成的日期時間，如果使用，則設定為寄件者的 TZ 或時區
訊息
 message string

您為派對提供的個人消息，輸入在群組電子郵件模板的中央。 使用已儲存電子郵件範本的名稱，前面加上雜湊符號，以使用該範本。 如果有多個同名的模板，它將選擇最後修改的模板。
名字
 firstname string

名字
姓氏
 lastname string

姓氏
電子郵件
 email True email

Email
include_link
 include_link boolean

包含簽署頁面的連結，讓檢閱者能夠簽署
簡訊
 sms string

使用國際格式號碼添加短信驗證。 如果是見證人或見證簽名者，則需要。
主題
 subject string

傳出電子郵件的主旨行
timezone
 timezone string

簽署者的 TZ 必須是有效的 TZ，符合 timezoneenum （如需 timezoneenum 詳細資料，請參閱 使用者）。 如果空白，則使用寄件者的tz。
簽名類型
 signature_type integer

使用 4 來獲得您執行的 PDF 認證。 推薦。 預設為 1 （使用 sha256 雜湊來確保文件完整性）。
附加 PDF
 append_pdf boolean

將 Legalesign 驗證資訊附加至最終 PDF。
auto_archive
 auto_archive boolean

簽署後立即發送到存檔。 保持 Web 應用程序整潔
使用 Legalesign 電子郵件
 do_email boolean

使用 Legalesign 電子郵件發送通知電子郵件。 如果 false 會隱藏所有電子郵件。
完成後抄送
 cc_emails string

以逗號分隔的電子郵件地址字串，通知簽署或拒絕。
將空白寄件者欄位轉換為第一個收件者欄位
 convert_sender_to_signer boolean

如果任何寄件者欄位留空，請將其轉換為第一個收件者的欄位。
PDF 密碼
 pdf_password string

設定密碼。 必須是 ASCII 編碼的，您也必須將 signature_type 設定為 4 並選擇pdf_password_type。
PDF 密碼設定
 pdf_password_type integer

1 用於存儲密碼，2 用於在最終簽署時從我們的記錄中刪除。
PDF文本
 pdftext object

將值指派給PDF寄件者欄位，使用範本的欄位標籤或其uuid作為物件索引鍵。 請參閱 templatepdf/：id/fields/ 並篩選 element_type=“admin”，以取得相關欄位及其標籤或 uuid。 另請參閱strict_fields。
重新導向 URL
 redirect string

簽署後要將簽署者傳送至的 URL （而不是下載頁面）。 您的網址將包含包含 ID 和狀態資訊的查詢參數，如下所示：YOUR-URL？signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status]
提醒時間表
 reminders string

如果您想在群組中使用默認提醒時間表，請輸入“默認”（轉到 Web 應用程序設置默認時間表）
傳回簽署者連結
 return_signer_links boolean

傳回回應 BODY 中簽署者的文件連結。
傳送排序
 signers_in_order boolean

按順序通知簽署者。 如果為 false，則同時通知所有內容。
簽名者文本
 signertext object

將自訂預留位置新增至簽署者欄位。 使用欄位標籤或 uuid 作為物件中的索引鍵 （如 pdftext）。 請參閱 templatepdf/：id/fields/ 並過濾 element_type = “text” 以獲取相關字段及其標籤或 uuid。
強制執行欄位驗證
 strict_fields boolean

Pdftext 以無訊息方式未通過驗證檢查，請設定 true 以驗證。
您的參考
 tag string

標記
您的參考
 tag1 string

標記
您的參考
 tag2 string

標記
使用者
 user string

指派檔案群組中的另一個使用者。

刪除附件

作業識別碼：
DeleteAttachment

刪除附件。

參數

名稱 機碼 必要 類型 Description
附件 ID
 attachId True uuid

附加標識符

取得 PDF 可嵌入連結

作業識別碼：
GetPdfTemplateEditLink

傳回內嵌 PDF 編輯器的一次性連結。

參數

名稱 機碼 必要 類型 Description
Pdf Id
 pdfId True string

設定上傳的 PDF ID。
從轉譯的頁面隱藏欄位清單
 hide_sender_fields boolean

隱藏轉譯頁面中的欄位清單。
十六進位代碼，不包括背景顏色的雜湊符號
 css_body_backgroundcolor string

使用十六進位代碼（不包括雜湊符號）來變更背景顏色。

取得 PDF 範本

作業識別碼：
GetPdfTemplates

列出 PDF 範本

參數

名稱 機碼 必要 類型 Description
群組識別碼
 group string

可以是完整的resource_uri或只有 id。
查詢限制
 limit integer

要傳回的資料集長度。 搭配偏移查詢使用，逐一查看結果。
查詢位移
 offset integer

從資料集開頭的偏移量。 與限制查詢搭配使用，以逐一查看資料集。

傳回

範本清單

身體
TemplatePdfListResponse

取得使用者

作業識別碼：
GetUser

取得使用者詳細資料。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
 userId True uuid

使用者識別碼

傳回

用戶的詳細數據。

身體
UserDetailResponse

取得收件者

作業識別碼：
GetRecipient

取得個別收件者的狀態和詳細資料。

參數

名稱 機碼 必要 類型 Description
收件者 ID
 recipientId True uuid

收件者 ID

傳回

收件者詳細資料

身體
SignerResponse

取得收件者拒絕原因

作業識別碼：
GetSignerRejection

傳回簽署者拒絕文件的原因。

參數

名稱 機碼 必要 類型 Description
收件者 ID
 recipientId True uuid

收件者 ID

傳回

名稱 路徑 類型 Description
狀態
 status integer

收件人雕像。
reason
 reason string

拒絕理由。

取得收件者表單欄位

作業識別碼：
GetSignerFields

傳回特定收件者的表單欄位。

參數

名稱 機碼 必要 類型 Description
收件者 ID
 recipientId True uuid

收件者 ID

傳回

名稱 路徑 類型 Description
array of object
標籤
 label string

標籤
label_extra
 label_extra string

額外標籤
狀態
 state boolean

State
欄位順序
 fieldorder integer

欄位順序
value
 value string

如果欄位是簽署者檔案，則此值將是短期下載URL。

取得收件者連結

作業識別碼：
GetSignerLink

收件人前往簽名頁面的一次性鏈接。

參數

名稱 機碼 必要 類型 Description
收件者 ID
 recipientId True uuid

收件者 ID

取得文件

作業識別碼：
GetDocument

傳回特定文件。

參數

名稱 機碼 必要 類型 Description
文件標識碼
 docId True uuid

文件 ID

傳回

文件詳細資料

身體
DocumentResponseDetail

取得文件

作業識別碼：
GetDocuments

列出未存檔的簽署文件。

參數

名稱 機碼 必要 類型 Description
群組識別碼
 group True string

依特定群組篩選 （必要）。
請包含封存文件
 archived string

過濾已存檔狀態，預設為未存檔，使用此參數中的值all查詢所有文件。
依收件者電子郵件篩選
 email string

依收件者電子郵件篩選。
查詢限制
 limit integer

要傳回的資料集長度。 搭配偏移查詢使用，逐一查看結果。
查詢位移
 offset integer

從資料集開頭的偏移量。 與限制查詢搭配使用，以逐一查看資料集。
依文件狀態篩選
 status integer

篩選文件狀態。
從回應中移除收件者
 nosigners string

新增值 1 以移除收件者資訊，以便加快查詢速度。
篩選在此日期之後建立的篩選器
 created_gt date-time

篩選在特定時間後建立的那些文件。
篩選在此日期之後修改的
 modified_gt date-time

篩選在特定時間後修改的那些文件。

傳回

文件清單

身體
DocumentListResponse

取得文件欄位

作業識別碼：
GetDocumentFields

文件中的欄位。

參數

名稱 機碼 必要 類型 Description
文件標識碼
 docId True uuid

文件 ID

傳回

名稱 路徑 類型 Description
array of object

文件欄位清單
element_type
 element_type string

項目類型
欄位順序
 fieldorder integer

欄位順序
標籤
 label string

標籤
label_extra
 label_extra string

額外標籤
簽署者
 signer integer

Recipient
狀態
 state boolean
確認
 validation integer

驗證識別碼
value
 value string

價值觀

取得群組

作業識別碼：
GetGroups

列出 API 使用者所屬的群組。

參數

名稱 機碼 必要 類型 Description
查詢位移
 offset integer

從資料集開頭的偏移量。 與限制查詢搭配使用，以逐一查看資料集。
查詢限制
 limit integer

要傳回的資料集長度。 搭配偏移查詢使用，逐一查看結果。

傳回

群組列表

身體
GroupListResponse

取得附件

作業識別碼：
GetAttachments

列出附件。

參數

名稱 機碼 必要 類型 Description
群組識別碼
 group string

按特定組過濾。
查詢限制
 limit integer

搭配 offset 使用來逐一查看結果。
查詢位移
 offset integer

使用 with limit 來逐一查看結果。

傳回

附件清單

身體
AttachmentListResponse

永久刪除文件

作業識別碼：
DeleteDocument

永久刪除資料和檔案。

參數

名稱 機碼 必要 類型 Description
文件標識碼
 docId True uuid

文件標識碼

獲取 PDF 模板

作業識別碼：
GetPdfTemplate

特定 PDF 範本的詳細資料

參數

名稱 機碼 必要 類型 Description
上傳的 PDF ID
 pdfId True uuid

上傳的 PDF ID

傳回

範本詳細資料

身體
TemplatePdfResponse

獲取依戀

作業識別碼：
GetAttachment

取得附件。

參數

名稱 機碼 必要 類型 Description
附件 ID
 attachId True uuid

附件 ID

傳回

附加項目。

身體
AttachmentResponse

群組成員

作業識別碼：
GetMember

群組內特定使用者的詳細資料。

參數

名稱 機碼 必要 類型 Description
會員編號
 memberId True uuid

會員編號

傳回

身體
MemberResponse

群組成員

作業識別碼：
GetMembers

您群組所有成員的清單。

參數

名稱 機碼 必要 類型 Description
群組識別碼
 group string

依特定群組篩選
查詢限制
 limit integer

搭配 offset 使用來逐一查看結果。
查詢位移
 offset integer

使用 with limit 來逐一查看結果。

傳回

身體
MemberListResponse

觸發程序

收件者事件

收件者事件發生時觸發
文件事件

發生文件事件的觸發程序

收件者事件

作業識別碼：
RecipientTrigger

收件者事件發生時觸發

參數

名稱 機碼 必要 類型 Description
事件篩選器
 eventFilter True string

事件篩選器
組成群組
 group string

群組篩選器

傳回

名稱 路徑 類型 Description
版本
 version string

版本
物件
 object string

物體
加標籤
 data.tag string

標記
標籤1
 data.tag1 string

標籤1
標籤2
 data.tag2 string

標籤2
全域唯一識別碼 (UUID)
 data.uuid string

收件者 ID
電子郵件
 data.email string

Email
組成群組
 data.group string

群體
順序
 data.order integer

訂單
狀態
 data.status integer

地位
文件
 data.document string

文件
姓氏
 data.lastname string

姓氏
角色文字
 data.roleText string

角色文字
名字
 data.firstname string

名字
status文本
 data.statusText string

狀態文字
電子郵件彈跳
 data.emailBounce integer

電子郵件確實被退回
resourceUri
 data.resourceUri string

收件者資源 uri
documentName 文件名稱
 data.documentName string

文件名稱
拒絕原因
 data.rejectReason string

拒絕原因
群組資源Uri
 data.groupResourceUri string

群組資源 uri
電子郵件Bounce訊息
 data.emailBounceMessage string

退回電子郵件訊息
documentResourceUri
 data.documentResourceUri string

文件資源 uri
created
 created integer

已建立
識別碼
 id string

ID
事件
 event string

Event

文件事件

作業識別碼：
DocumentTrigger

發生文件事件的觸發程序

參數

名稱 機碼 必要 類型 Description
事件篩選器
 eventFilter True string

事件篩選器
組成群組
 group string

群組篩選器

傳回

名稱 路徑 類型 Description
版本
 version string

版本
物件
 object string

物體
標籤1
 data.tag1 string

標記
recipients
 data.recipients array of object

收件者
全域唯一識別碼 (UUID)
 data.recipients.uuid string

收件者 ID
電子郵件
 data.recipients.email string

收件者電子郵件
順序
 data.recipients.order integer

收件人訂單編號
狀態
 data.recipients.status integer

收件者狀態
姓氏
 data.recipients.lastname string

收件者姓氏
角色文字
 data.recipients.roleText string

收件者角色文字
名字
 data.recipients.firstname string

收件人名字
status文本
 data.recipients.statusText string

收件者狀態文字
resourceUri
 data.recipients.resourceUri string

收件者資源 uri
拒絕原因
 data.recipients.rejectReason string

拒絕原因
群組資源Uri
 data.groupResourceUri string

群組資源 uri
status文本
 data.statusText string

文件狀態文字
名稱
 data.name string

文件名稱
加標籤
 data.tag string

標記
resourceUri
 data.resourceUri string

資源 uri
全域唯一識別碼 (UUID)
 data.uuid string

文件標識碼
標籤2
 data.tag2 string

標籤2
組成群組
 data.group string

群體
狀態
 data.status integer

文件狀態
created
 created integer

已建立
識別碼
 id string

做過
事件
 event string

Event

定義

PermissionsEnum

權限選項

權限選項

integer

列表元

有關列表的元信息。

名稱 路徑 類型 Description
limit
 limit integer

物件數目上限。
next
 next string

下一組物件的 URL。
位移
 offset integer

從結果集開頭開始的項目數。
前
 previous string

先前物件集的URL。
total_count
 total_count integer

物件總數。

GroupList回應

群組列表

名稱 路徑 類型 Description
元數據
 meta ListMeta

有關列表的元信息。
物件
 objects array of object
created
 objects.created date-time

已建立
is_active
 objects.is_active boolean

Active
修改後
 objects.modified date-time

已修改
名稱
 objects.name string

名稱
public_name
 objects.public_name string

公開名稱
resource_uri
 objects.resource_uri string

資源 uri
蛞蝓
 objects.slug string

唯一名稱
使用者
 objects.user string

建立者資源 uri
xframe_allow
 objects.xframe_allow boolean

允許內嵌簽署
xframe_allow_pdf_edit
 objects.xframe_allow_pdf_edit boolean

允許內嵌編輯

TemplatePdfList回應

範本清單

名稱 路徑 類型 Description
元數據
 meta ListMeta

有關列表的元信息。
物件
 objects array of TemplatePdfResponse

TemplatePdf回應

範本詳細資料

名稱 路徑 類型 Description
created
 created date-time

已建立
組成群組
 group string

群組 uri
修改後
 modified date-time

已修改
當事人
 parties string

文件當事人的 JSON 字串化陣列。
page_count
 page_count integer

頁數
resource_uri
 resource_uri string

資源 uri
signer_count
 signer_count integer

簽署者計數
title
 title string

Title
使用者
 user string

建立者的資源 uri
全域唯一識別碼 (UUID)
 uuid uuid

Pdf Id
有效
 valid boolean

可以傳送 （如果欄位未驗證）。

DocumentList回應

文件清單

名稱 路徑 類型 Description
元數據
 meta ListMeta

有關列表的元信息。
物件
 objects array of object

Documents
已存檔
 objects.archived boolean

Archived
auto_archive
 objects.auto_archive boolean

發送後存檔。
cc_emails
 objects.cc_emails string

完成後，以逗號分隔的清單電子郵件傳送至抄送。
created
 objects.created date-time

已建立
do_email
 objects.do_email boolean

使用 Legalesign 電子郵件。
download_final
 objects.download_final boolean

完成後即可下載。
組成群組
 objects.group string

群組資源 URI。
修改後
 objects.modified date-time

已修改
名稱
 objects.name string

文件名稱
PDF文本
 objects.pdftext string

寄件者欄位值
重新導向
 objects.redirect string

簽署後重新導向收件者的URL
resource_uri
 objects.resource_uri string

資源 uri
return_signer_links
 objects.return_signer_links boolean

將收件者連結新增至回應
簽署者
 objects.signers array of array

具有簽署者詳細資料的巢狀陣列
items
 objects.signers array of

一律包含 [簽署者 URI、名字、姓氏、電子郵件、簡訊號碼、has_fields、狀態、簽署者順序 （0 索引）]
signers_in_order
 objects.signers_in_order integer

同時或循序傳送電子郵件收件者
狀態
 objects.status DocumentStatusEnum

文件狀態選項：

  • 10 - 初始狀態，檢查簽署者狀態是否有已傳送/未傳送
  • 20 - 已完成的欄位
  • 30 - 已簽名
  • 40 - 已刪除（簽署前）
  • 50 - 已拒絕
加標籤
 objects.tag string

標籤文件
標籤1
 objects.tag1 string

標籤文件
標籤2
 objects.tag2 string

標籤文件
樣板
 objects.template string

範本資源 uri （如果使用）
範本PDF
 objects.templatepdf string

PDF 範本資源 uri
收發簡訊
 objects.text string

簽署文字
使用者
 objects.user string

建立者 uri
全域唯一識別碼 (UUID)
 objects.uuid uuid

文件標識碼

DocumentStatusEnum

文件狀態選項：

  • 10 - 初始狀態，檢查簽署者狀態是否有已傳送/未傳送
  • 20 - 已完成的欄位
  • 30 - 已簽名
  • 40 - 已刪除（簽署前）
  • 50 - 已拒絕

文件狀態選項：

  • 10 - 初始狀態，檢查簽署者狀態是否有已傳送/未傳送
  • 20 - 已完成的欄位
  • 30 - 已簽名
  • 40 - 已刪除（簽署前）
  • 50 - 已拒絕
integer

簽署者回應

收件者詳細資料

名稱 路徑 類型 Description
文件
 document string

文件
電子郵件
 email string

收件者電子郵件
first_name
 first_name string

收件人名字
姓氏
 last_name string

收件者姓氏
has_fields
 has_fields boolean

收件者有欄位
順序
 order integer

收件者順序
resource_uri
 resource_uri string

收件者資源 uri
狀態
 status SignerStatusEnum

簽署者狀態選項：

  • 4 - 未發送
  • 5 - 預定發送
  • 10 - 已發送
  • 15 - 電子郵件已開啟
  • 20 - 已造訪
  • 30 - 欄位已完成
  • 35 - 欄位完成前簽名
  • 39 - 等待見證完成
  • 40 - 簽名
  • 50 - 已下載
  • 60 - 拒絕

SignerStatusEnum

簽署者狀態選項：

  • 4 - 未發送
  • 5 - 預定發送
  • 10 - 已發送
  • 15 - 電子郵件已開啟
  • 20 - 已造訪
  • 30 - 欄位已完成
  • 35 - 欄位完成前簽名
  • 39 - 等待見證完成
  • 40 - 簽名
  • 50 - 已下載
  • 60 - 拒絕

簽署者狀態選項：

  • 4 - 未發送
  • 5 - 預定發送
  • 10 - 已發送
  • 15 - 電子郵件已開啟
  • 20 - 已造訪
  • 30 - 欄位已完成
  • 35 - 欄位完成前簽名
  • 39 - 等待見證完成
  • 40 - 簽名
  • 50 - 已下載
  • 60 - 拒絕
integer

文件回應詳細資料

文件詳細資料

名稱 路徑 類型 Description
已存檔
 archived boolean

已存檔
auto_archive
 auto_archive boolean

簽署後發送文件存檔。
cc_emails
 cc_emails string

簽名後，誰將在電子郵件通知中被抄送給寄件者
created
 created date-time

已建立
do_email
 do_email boolean

使用 Legalesign 電子郵件
download_final
 download_final boolean

最終 PDF 可供下載
頁尾
 footer string

HTML 文件 - 頁尾文字（如果使用）
footer_height
 footer_height integer

HTMl 文檔 - 頁腳的 px 高度（如果使用）
組成群組
 group string

群組的資源 uri
has_fields
 has_fields boolean

文件有欄位
hash_value
 hash_value string

SHA256 最終文件的校驗和，請使用它來驗證您的最終 PDF 下載
標頭
 header string

HTML 文件 - 標題文字（如果使用）
header_height
 header_height integer

HTMl 文檔 - 標頭的 px 高度（如果使用）
修改後
 modified date-time

已修改
名稱
 name string

文件名稱
pdf_password
 pdf_password string

PDF 密碼
pdf_password_type
 pdf_password_type string

如果保留 pdf 密碼
PDF文本
 pdftext string

忽略這個
重新導向
 redirect string

簽署後收件者重新導向的 URL
resource_uri
 resource_uri string

資源 uri
return_signer_links
 return_signer_links boolean

忽視
sign_mouse
 sign_mouse boolean

忽略
sign_time
 sign_time date-time

簽約時間
sign_type
 sign_type boolean

繼承式
sign_upload
 sign_upload boolean

繼承式
signature_placement
 signature_placement integer

繼承式
signature_type
 signature_type integer

傳承 - 永遠 4
簽署者
 signers array of array

具有簽署者詳細資料的巢狀陣列
items
 signers array of

一律包含 [簽署者 URI、名字、姓氏、電子郵件、簡訊號碼、has_fields、狀態、簽署者順序 （0 索引）]
signer_objects
 signer_objects array of object

收件人名單
電子郵件
 signer_objects.email string

Email
名字
 signer_objects.firstname string

名字
姓氏
 signer_objects.lastname string

姓氏
電話
 signer_objects.tel string

電話號碼
順序
 signer_objects.order integer

簽署順序
resource_uri
 signer_objects.resource_uri string

資源 uri
角色
 signer_objects.role string

Role
狀態
 signer_objects.status integer

收件者狀態碼
全域唯一識別碼 (UUID)
 signer_objects.uuid string

收件者 ID
signers_in_order
 signers_in_order boolean

同時或循序傳送電子郵件收件者
狀態
 status DocumentStatusEnum

文件狀態選項：

  • 10 - 初始狀態，檢查簽署者狀態是否有已傳送/未傳送
  • 20 - 已完成的欄位
  • 30 - 已簽名
  • 40 - 已刪除（簽署前）
  • 50 - 已拒絕
加標籤
 tag string

您的參考
標籤1
 tag1 string

您的參考
標籤2
 tag2 string

您的參考
樣板
 template string

文字範本的資源 uri （如果使用）
範本PDF
 templatepdf string

pdf 範本的資源 uri （如果使用）
收發簡訊
 text string

文件的文字（如果使用）
使用者
 user string

使用者資源 uri。
全域唯一識別碼 (UUID)
 uuid uuid

文件標識碼

MemberList回應

名稱 路徑 類型 Description
元數據
 meta ListMeta

有關列表的元信息。
物件
 objects array of MemberResponse

成員回應

名稱 路徑 類型 Description
created
 created date-time

已建立
組成群組
 group string

群組資源 uri
修改後
 modified date-time

已修改
使用權限
 permission PermissionsEnum

權限選項
resource_uri
 resource_uri string

資源 uri
使用者
 user string

使用者資源 uri。

Attachment回應

附加項目。

名稱 路徑 類型 Description
created
 created date-time

已建立
description
 description string

Description
filename
 filename string

檔案名稱
組成群組
 group string

群體
resource_uri
 resource_uri string

附加資源 URI
使用者
 user string

使用者資源 uri
全域唯一識別碼 (UUID)
 uuid uuid

附加標識符

AttachmentList回應

附件清單

名稱 路徑 類型 Description
元數據
 meta ListMeta

有關列表的元信息。
物件
 objects array of object

上市
created
 objects.created date-time

已建立
description
 objects.description string

Description
filename
 objects.filename string

檔案名稱
組成群組
 objects.group string

群體
resource_uri
 objects.resource_uri string

資源 uri
使用者
 objects.user string

使用者資源 uri
全域唯一識別碼 (UUID)
 objects.uuid uuid

附加標識符

UserDetail回應

用戶的詳細數據。

名稱 路徑 類型 Description
date_joined
 date_joined date-time

加入日期
電子郵件
 email email

Email
first_name
 first_name string

名字
groups
 groups array of string

此使用者已加入的群組清單。
last_login
 last_login date-time

上次登入
姓氏
 last_name string

姓氏
resource_uri
 resource_uri string

資源 uri
timezone
 timezone string

時區
使用者名稱
 username string

用戶名稱

檔案

這是基本資料類型「檔案」。