寄件人的電子郵件。 必須屬於你保險計畫的成員。

寄件人的名字。

寄件人的姓氏。

寄件人在所有文件中的角色。

收件人的電子郵件。

收件者的名字。

收件者的姓氏。

若設定為 true 無，則會發送電子郵件給收件人。

僅在邀請時收件人 電子郵件地址未知 時使用。 這只在你邀請收件人（不包括準備路線）且你想使用 fastlane 時才有效。 這 customId 讓你能在寄出邀請前，預先生成一個獨特的簽名連結給收件人。 必須是唯一且至少有70個字元的字母數字串。

注意：customId只能用來建立文件的收件人連結。 它不能用於其他請求，而非 memberId。 關於 URL 建構的詳細資訊，請參見「以自訂 ID 開啟文件」

若設定為 ， true 簽署者會在邀請郵件中收到 Fastlane 連結。

收件人的電話號碼。 這用於簡訊驗證。 （例如：+43 699 1234 1234）。

給這位特定收件人的私人訊息。

啟用此選項後，簽名請求的收件人需親自簽署文件，且不會發送電子郵件。 此模式僅適用於 SES 簽章類型

簽名類型允許此收件人使用。 最多支援一個值。 選項：「進階」、「進階加成」、「合格」、「合格加識別」、「簡單」

此標籤決定將用於簽署程序的身份提供者。 從預設的支援提供者組合中選擇。

註1： 有些供應商僅支援特定簽名類型，例如 onetimeqes 會要求 "signatureType" : ["qualifiedPlusIdent"]

註2： 使用 sproof-qualified 預設提供者時，收件人必須擁有有效的 sproof 帳號且擁有有效的 User+ 授權。

布林值表示受邀收件人是否應該能更改簽名提供者

預設國家如果是空白，則設為全境，會回傳錯誤，顯示所選提供者標籤可用的國家

文件可簽署的日期。 這個截止日期會在邀請郵件中顯示給收件人，也會在儀表板的文件細節區塊中看到。 它作為完成簽約程序的截止日期。

規定提醒郵件之間的天數。

提醒應該從哪個日期開始發送

規定寄給無帳號匿名用戶的電子郵件用語。 對於擁有帳號的用戶，將使用他們在個人資料中選擇的語言。

電子郵件中寄給收件人的自訂訊息。

寄給收件人的電子郵件主旨行。

若設定為 true，PDF 會作為附件寄送給文件中所有收件人（若檔案大小小於 5MB）。

啟用此選項後，簽名請求的收件人將只能簽署或拒絕文件，且無法離開頁面。

允許轉發邀請函。

一個物件，每個鍵代表一輪簽名，其對應值則表示該輪是否啟用協同簽署。 若該值為真，只需一個簽名即可完成指定的簽名輪並進入下一輪。 例如，{ '1'： true } 表示在簽署 '1' 輪時，只需一個簽名。

當符合時，收件人會跳出一個視窗，要求他手動繪製簽名

若提供，將建立一個包含 documentDataArray 中所有文件的信封。 （若需寄出多份文件）

當建立新簽章或收件人拒絕該文件時，會將包含文件的 POST 請求發送至此網址。 若失敗，會設有重試機制以確保請求能被重試。

簽署文件後返回按鈕的連結

簽署文件後返回按鈕的文字

文件（PDF 或 DOCX）資料以 base64 格式呈現。

如果文件不是 PDF，則需要 MIME 類型的 base64 編碼資料 PDF 或 DOCX

檔案名稱

一個可以寄送來整理文件的自訂標籤。

該方框所在的頁面號碼，第一頁為 0。

任何描述頁面寬度的整數值。 數字越大，定位盒子在 x y 空間的精確度越高。 在A4紙上，預設值是478。

任何描述頁面高度的整數值。 數字越大，定位盒子在 x y 空間的精確度越高。 在A4紙上，預設值是676。

代表方框的水平位置，以頁面寬度的百分比表示。 原點（0,0）位於頁面左上角。 值為 0.1 表示該框位於頁面寬度的左起 10%。

表示方框的垂直位置，以頁面高度的百分比表示。 原點（0,0）位於頁面左上角。 值為 0.1 表示該方框位於頁面高度的 10% 處。

根據頁面尺寸計算方框寬度，類似於 x 和 y 座標。 它是一個浮點點，代表頁面寬度的百分比。

根據頁面尺寸計算盒子的高度，類似於 x 和 y 座標。 它是一個浮點，代表 pageHeight 的百分比。

這個盒子有唯一的 ID，可以隨你怎麼產生。

佔位文字，例如欄位名稱，例如「出生日期」。

盒子的預設值。 可以是 null。 若該框型別為「chooseBox」，該值可為空值或選項中定義的字串之一。

一個在使用者介面中設定的穩定欄位識別碼。 用來透過 API 請求預先填寫工作流程表單欄位。

若設為 true，受邀者無法修改此框的值。

若設為 true，受邀者必須填寫此框即可簽署文件。

是否允許多條線路。

每個無線電盒都可以分配到一個群組。

本文件允許的簽章類型，可以被接收者簽章類型覆蓋。 最多支援一個值。 選項：「進階」、「進階加成」、「合格」、「簡單」、「合格加身份證」

refId 是一個選填欄位，用來交叉比對上傳的文件。 如果有提供，它允許你為文件指派自訂的參考識別碼，該識別碼會在未來的 API 回應中作為文件物件的一部分回傳。 這對於透過外部系統或工作流程追蹤或組織文件非常有用。

文件語言。

文件應該插入資料夾的 ID。 這只有在 inviteData 和 folderName 都未定義時才可能。

此時不需要 isAttachment。

若設定為 ， true 簽署者會在邀請郵件中收到 Fastlane 連結。

請指定與本文件一起使用的 Fastlane 設定檔。 （useFastlane 必須設為 true）。

會員編號

只有在提供文件屬於寄件人時才適用 memberId 。 若設定為 true，該文件會對寄件人及所有收件人一同刪除。 若設定為 false，該文件僅對寄件人可刪除，其他收件人仍可使用。 此參數對信封中的文件（預設 = true）或 memberId 信封屬於收件人時無效。

會員編號

規定回應格式。 用於 pdf 二進位 PDF 及 base64 Base64 編碼的回應。 範例 base64 回應： json { "base64": "JVBERi0xLjQKJe..." }

指定每頁條目數量。

請指定頁碼。

請指定文件篩選器。

文件分類。 附加「：true」以進行降序排序。

搜尋查詢各種資訊。

態度：

• 一般來說，大小寫不區分
• 單字或引用短語（例如「季報」）會進行子字串匹配
• 多個以空格分隔的字（例如季度報告 Q1）必須全部作為子字串（AND 條件）相匹配
• 搜尋欄位：文件名稱、會員電子郵件、會員姓名、資料夾名稱
• 不支援萬用字元/正則表達式
• 如果內部搜尋索引尚未更新，則只會搜尋文件名稱

依標籤名稱篩選文件。

以 UTC 格式篩選從特定 createdAt 日期和時間開始的結果（ 不 依 updatedAt 篩選）。 使用此參數與「endDate」結合定義時間範圍。

以 UTC 格式篩選以特定 createdAt 日期和時間結束的結果（ 不 依 updatedAt 篩選）。 使用此參數與「startDate」結合，定義時間範圍。

寄件人的電子郵件。 必須屬於你保險計畫的成員。

寄件人的名字。

寄件人的姓氏。

寄件人在所有文件中的角色。

收件人的電子郵件。

收件者的名字。

收件者的姓氏。

若設定為 true 無，則會發送電子郵件給收件人。

僅在邀請時收件人 電子郵件地址未知 時使用。 這只在你邀請收件人（不包括準備路線）且你想使用 fastlane 時才有效。 這 customId 讓你能在寄出邀請前，預先生成一個獨特的簽名連結給收件人。 必須是唯一且至少有70個字元的字母數字串。

注意：customId只能用來建立文件的收件人連結。 它不能用於其他請求，而非 memberId。 關於 URL 建構的詳細資訊，請參見「以自訂 ID 開啟文件」

若設定為 ， true 簽署者會在邀請郵件中收到 Fastlane 連結。

收件人的電話號碼。 這用於簡訊驗證。 （例如：+43 699 1234 1234）。

給這位特定收件人的私人訊息。

啟用此選項後，簽名請求的收件人需親自簽署文件，且不會發送電子郵件。 此模式僅適用於 SES 簽章類型

簽名類型允許此收件人使用。 最多支援一個值。 選項：「進階」、「進階加成」、「合格」、「合格加識別」、「簡單」

此標籤決定將用於簽署程序的身份提供者。 從預設的支援提供者組合中選擇。

註1： 有些供應商僅支援特定簽名類型，例如 onetimeqes 會要求 "signatureType" : ["qualifiedPlusIdent"]

註2： 使用 sproof-qualified 預設提供者時，收件人必須擁有有效的 sproof 帳號且擁有有效的 User+ 授權。

布林值表示受邀收件人是否應該能更改簽名提供者

預設國家如果是空白，則設為全境，會回傳錯誤，顯示所選提供者標籤可用的國家

文件可簽署的日期。 這個截止日期會在邀請郵件中顯示給收件人，也會在儀表板的文件細節區塊中看到。 它作為完成簽約程序的截止日期。

規定提醒郵件之間的天數。

提醒應該從哪個日期開始發送

規定寄給無帳號匿名用戶的電子郵件用語。 對於擁有帳號的用戶，將使用他們在個人資料中選擇的語言。

電子郵件中寄給收件人的自訂訊息。

寄給收件人的電子郵件主旨行。

若設定為 true，PDF 會作為附件寄送給文件中所有收件人（若檔案大小小於 5MB）。

啟用此選項後，簽名請求的收件人將只能簽署或拒絕文件，且無法離開頁面。

允許轉發邀請函。

一個物件，每個鍵代表一輪簽名，其對應值則表示該輪是否啟用協同簽署。 若該值為真，只需一個簽名即可完成指定的簽名輪並進入下一輪。 例如，{ '1'： true } 表示在簽署 '1' 輪時，只需一個簽名。

如果屬實，文件中儲存的文字佔位符/表單欄位將被用來邀請收件人。

當符合時，收件人會跳出一個視窗，要求他手動繪製簽名

若提供，將建立一個包含 documentDataArray 中所有文件的信封。 （若需寄出多份文件）

當建立新簽章或收件人拒絕該文件時，會將包含文件的 POST 請求發送至此網址。 若失敗，會設有重試機制以確保請求能被重試。

簽署文件後返回按鈕的連結

簽署文件後返回按鈕的文字

文件（PDF 或 DOCX）資料以 base64 格式呈現。

如果文件不是 PDF，則需要 MIME 類型的 base64 編碼資料 PDF 或 DOCX

檔案名稱

一個可以寄送來整理文件的自訂標籤。

該方框所在的頁面號碼，第一頁為 0。

任何描述頁面寬度的整數值。 數字越大，定位盒子在 x y 空間的精確度越高。 在A4紙上，預設值是478。

任何描述頁面高度的整數值。 數字越大，定位盒子在 x y 空間的精確度越高。 在A4紙上，預設值是676。

代表方框的水平位置，以頁面寬度的百分比表示。 原點（0,0）位於頁面左上角。 值為 0.1 表示該框位於頁面寬度的左起 10%。

表示方框的垂直位置，以頁面高度的百分比表示。 原點（0,0）位於頁面左上角。 值為 0.1 表示該方框位於頁面高度的 10% 處。

根據頁面尺寸計算方框寬度，類似於 x 和 y 座標。 它是一個浮點點，代表頁面寬度的百分比。

根據頁面尺寸計算盒子的高度，類似於 x 和 y 座標。 它是一個浮點，代表 pageHeight 的百分比。

這個盒子有唯一的 ID，可以隨你怎麼產生。

佔位文字，例如欄位名稱，例如「出生日期」。

盒子的預設值。 可以是 null。 若該框型別為「chooseBox」，該值可為空值或選項中定義的字串之一。

一個在使用者介面中設定的穩定欄位識別碼。 用來透過 API 請求預先填寫工作流程表單欄位。

若設為 true，受邀者無法修改此框的值。

若設為 true，受邀者必須填寫此框即可簽署文件。

是否允許多條線路。

每個無線電盒都可以分配到一個群組。

本文件允許的簽章類型，可以被接收者簽章類型覆蓋。 最多支援一個值。 選項：「進階」、「進階加成」、「合格」、「簡單」、「合格加身份證」

refId 是一個選填欄位，用來交叉比對上傳的文件。 如果有提供，它允許你為文件指派自訂的參考識別碼，該識別碼會在未來的 API 回應中作為文件物件的一部分回傳。 這對於透過外部系統或工作流程追蹤或組織文件非常有用。

文件語言。

文件應該插入資料夾的 ID。 這只有在 inviteData 和 folderName 都未定義時才可能。

此時不需要 isAttachment。

收件人資料依收件人電子郵件鍵入。 範例：{“mail@test.com”：{“role”：signer“，”signaturePositions“：[{”page“：0，”x“：0.55，”y“：0.80，”width“：0.25，”height“：0.08}]}}。

若設定為 ， true 簽署者會在邀請郵件中收到 Fastlane 連結。

請指定與本文件一起使用的 Fastlane 設定檔。 （useFastlane 必須設為 true）。

會員編號

寄件人的電子郵件。 必須屬於你保險計畫的成員。

寄件人的名字。

寄件人的姓氏。

寄件人在所有文件中的角色。

收件人的電子郵件。

收件者的名字。

收件者的姓氏。

若設定為 true 無，則會發送電子郵件給收件人。

僅在邀請時收件人 電子郵件地址未知 時使用。 這只在你邀請收件人（不包括準備路線）且你想使用 fastlane 時才有效。 這 customId 讓你能在寄出邀請前，預先生成一個獨特的簽名連結給收件人。 必須是唯一且至少有70個字元的字母數字串。

注意：customId只能用來建立文件的收件人連結。 它不能用於其他請求，而非 memberId。 關於 URL 建構的詳細資訊，請參見「以自訂 ID 開啟文件」

若設定為 ， true 簽署者會在邀請郵件中收到 Fastlane 連結。

收件人的電話號碼。 這用於簡訊驗證。 （例如：+43 699 1234 1234）。

給這位特定收件人的私人訊息。

啟用此選項後，簽名請求的收件人需親自簽署文件，且不會發送電子郵件。 此模式僅適用於 SES 簽章類型

簽名類型允許此收件人使用。 最多支援一個值。 選項：「進階」、「進階加成」、「合格」、「合格加識別」、「簡單」

此標籤決定將用於簽署程序的身份提供者。 從預設的支援提供者組合中選擇。

註1： 有些供應商僅支援特定簽名類型，例如 onetimeqes 會要求 "signatureType" : ["qualifiedPlusIdent"]

註2： 使用 sproof-qualified 預設提供者時，收件人必須擁有有效的 sproof 帳號且擁有有效的 User+ 授權。

布林值表示受邀收件人是否應該能更改簽名提供者

預設國家如果是空白，則設為全境，會回傳錯誤，顯示所選提供者標籤可用的國家

文件可簽署的日期。 這個截止日期會在邀請郵件中顯示給收件人，也會在儀表板的文件細節區塊中看到。 它作為完成簽約程序的截止日期。

規定提醒郵件之間的天數。

提醒應該從哪個日期開始發送

規定寄給無帳號匿名用戶的電子郵件用語。 對於擁有帳號的用戶，將使用他們在個人資料中選擇的語言。

電子郵件中寄給收件人的自訂訊息。

寄給收件人的電子郵件主旨行。

若設定為 true，PDF 會作為附件寄送給文件中所有收件人（若檔案大小小於 5MB）。

啟用此選項後，簽名請求的收件人將只能簽署或拒絕文件，且無法離開頁面。

允許轉發邀請函。

一個物件，每個鍵代表一輪簽名，其對應值則表示該輪是否啟用協同簽署。 若該值為真，只需一個簽名即可完成指定的簽名輪並進入下一輪。 例如，{ '1'： true } 表示在簽署 '1' 輪時，只需一個簽名。

如果屬實，文件中儲存的文字佔位符/表單欄位將被用來邀請收件人。

當符合時，收件人會跳出一個視窗，要求他手動繪製簽名

若提供，將建立一個包含 documentDataArray 中所有文件的信封。 （若需寄出多份文件）

當建立新簽章或收件人拒絕該文件時，會將包含文件的 POST 請求發送至此網址。 若失敗，會設有重試機制以確保請求能被重試。

簽署文件後返回按鈕的連結

簽署文件後返回按鈕的文字

文件（PDF 或 DOCX）資料以 base64 格式呈現。

如果文件不是 PDF，則需要 MIME 類型的 base64 編碼資料 PDF 或 DOCX

檔案名稱

一個可以寄送來整理文件的自訂標籤。

該方框所在的頁面號碼，第一頁為 0。

任何描述頁面寬度的整數值。 數字越大，定位盒子在 x y 空間的精確度越高。 在A4紙上，預設值是478。

任何描述頁面高度的整數值。 數字越大，定位盒子在 x y 空間的精確度越高。 在A4紙上，預設值是676。

代表方框的水平位置，以頁面寬度的百分比表示。 原點（0,0）位於頁面左上角。 值為 0.1 表示該框位於頁面寬度的左起 10%。

表示方框的垂直位置，以頁面高度的百分比表示。 原點（0,0）位於頁面左上角。 值為 0.1 表示該方框位於頁面高度的 10% 處。

根據頁面尺寸計算方框寬度，類似於 x 和 y 座標。 它是一個浮點點，代表頁面寬度的百分比。

根據頁面尺寸計算盒子的高度，類似於 x 和 y 座標。 它是一個浮點，代表 pageHeight 的百分比。

這個盒子有唯一的 ID，可以隨你怎麼產生。

佔位文字，例如欄位名稱，例如「出生日期」。

盒子的預設值。 可以是 null。 若該框型別為「chooseBox」，該值可為空值或選項中定義的字串之一。

一個在使用者介面中設定的穩定欄位識別碼。 用來透過 API 請求預先填寫工作流程表單欄位。

若設為 true，受邀者無法修改此框的值。

若設為 true，受邀者必須填寫此框即可簽署文件。

是否允許多條線路。

每個無線電盒都可以分配到一個群組。

本文件允許的簽章類型，可以被接收者簽章類型覆蓋。 最多支援一個值。 選項：「進階」、「進階加成」、「合格」、「簡單」、「合格加身份證」

refId 是一個選填欄位，用來交叉比對上傳的文件。 如果有提供，它允許你為文件指派自訂的參考識別碼，該識別碼會在未來的 API 回應中作為文件物件的一部分回傳。 這對於透過外部系統或工作流程追蹤或組織文件非常有用。

文件語言。

文件應該插入資料夾的 ID。 這只有在 inviteData 和 folderName 都未定義時才可能。

此時不需要 isAttachment。

收件人資料依收件人電子郵件鍵入。 範例：{“mail@test.com”：{“role”：signer“，”signaturePositions“：[{”page“：0，”x“：0.55，”y“：0.80，”width“：0.25，”height“：0.08}]}}。

若設定為 ， true 簽署者會在邀請郵件中收到 Fastlane 連結。

請指定與本文件一起使用的 Fastlane 設定檔。 （useFastlane 必須設為 true）。