sproof標誌（預覽）

使用 sproof Sign 自動化 PDF 與 DOCX 文件的安全電子簽名工作流程。 組織可以建立單一或多文件的簽名請求、指派收件人與簽署角色、追蹤狀態、下載已完成的 PDF 以及刪除文件。 需要一個 sproof Sign 帳號、一個支援所選動作與簽章類型的計畫，以及有效的 API 令牌。

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

Service	Class	Regions
Copilot Studio	進階	除以下部分外，所有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://sproof.com
Email	support@sproof.com

連接器中繼資料
發行者	sproof GmbH
網站	https://www.sproof.com/en/sign/
隱私策略	https://www.sproof.com/en/privacy-policy-app/
類別	生產力;內容和文件

證明標誌

Overview

sproof Sign 使組織能自動化 PDF 與 DOCX 文件的電子簽名工作流程。 連接器可建立單一文件簽名請求或多文件信封、指派收件人與簽署角色、檢索請求狀態、下載已完成的文件及刪除文件。

先決條件

若要使用連接器，您需要：

• 一個安全的簽名帳號。
• 一個具備 API 存取權限及支援所需動作與簽章類型的 sproof Sign 計畫。
• 一個有效的 sproof（證明） Sign API 令牌。

Authentication

連接器採用 API 令牌認證。 透過輸入與你帳戶綁定的有效 sproof Sign API 令牌來建立連線。 保管代幣安全，若被撤銷或重新生成，請重新更換。

支援行動

• 建立簽名請求 — 建立一份文件或包含多份文件的信封請求。 收件人、簽署角色、簽名順序、簽名位置及其他邀請設定皆可設定。
• 使用佔位符建立簽名請求 — 使用儲存在上傳文件中的佔位符建立請求。 接收者資訊與簽名位置會從這些佔位符中擷取。
• 取得請求狀態 — 利用簽章請求的成員 ID 取得其當前狀態與簽署狀態。
• 取得文件 — 下載文件為二進位 PDF 或 Base64 編碼的 PDF。
• 刪除文件 — 根據所提供的成員 ID、成員角色及文件是否屬於信封，刪除文件或移除成員的存取權限。

已知的限制與需求

• 輸入文件必須以 Base64 編碼的 PDF 或 DOCX 內容提供。
• 一個信封最多可裝25份文件。
• 當提交多份文件時，需要使用信封名稱。
• 佔位式請求需要上傳文件中格式正確的佔位符。
• 對於佔位式請求，收件人與簽名位置則從文件中取得，而非手動輸入。
• 可用的動作、簽章類型與服務取決於所連結的 Sproof Sign 帳戶與方案。
• 文件刪除行為取決於所提供的成員 ID 是屬於寄件人還是收件人，以及該文件是否屬於信封。

Support

如需連接器或 API 支援，請聯絡 support@sproof.com。

正在建立連線

連接器支援下列驗證類型：

預設值	建立連線的參數。	所有地區	不可共享

預設

適用：所有地區

建立連線的參數。

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

名稱	類型	Description	Required
Token	安全字串	“token” für diese API	沒錯

動作

使用佔位符建立簽名請求	利用上傳文件中儲存的佔位符建立簽名請求。 收件人與簽名位置會從文件中擷取。
刪除文件	刪除文件或移除成員對該文件的存取權限，視所提供的 memberId 文件屬於寄件人或收件人，以及該文件是否屬於信封而定。 信封中文件 查詢參數 all 對信封中的文件沒有影響。 與寄件 memberId人： 發送者和所有收件人會刪除一份文件。 文件會從信封中取出。 與受獎者 memberId： 信封內所有文件都會被收件人取出。 收件人在所有為收件人刪除的文件上都會被標記為declined 文件仍對文件中其他成員開放。 單一文件 與發送 memberId 者 及 all=true： 該文件對寄件人及所有收件人皆已刪除。 與發送 memberId 者 及 all=false： 該文件只會被刪除給寄件人使用。 該文件仍對其他收件人開放。 與受獎者 memberId： 收件人會在文件上標示為declined 該文件仍對文件中其他成員開放。
取得文件	以二進位或 Base64 編碼的字串形式簽署文件。
建立簽名請求	這是新的建立簽名請求。 除了建立單一文件邀請外，現在還支援在發送邀請時建立信封並一次上傳多份文件。
查詢請求狀態	查詢簽名請求的狀態。 回傳文件 JSON 物件或錯誤訊息。 該參數由文件上的郵件請求回傳，並與寄件者的電子郵件相關聯。

使用佔位符建立簽名請求

作業識別碼：

CreateSignatureRequestUsingPlaceholders

利用上傳文件中儲存的佔位符建立簽名請求。 收件人與簽名位置會從文件中擷取。

參數

名稱	機碼	必要	類型	Description
電子郵件	email	True	string	寄件人的電子郵件。 必須屬於你保險計畫的成員。
firstName	firstName	True	string	寄件人的名字。
lastName	lastName		string	寄件人的姓氏。
角色	role		string	寄件人在所有文件中的角色。
電子郵件	email		string	收件人的電子郵件。
firstName	firstName		string	收件者的名字。
lastName	lastName		string	收件者的姓氏。
doNotSendEmails	doNotSendEmails		boolean	若設定為 true 無，則會發送電子郵件給收件人。
自訂標識碼	customId		string	僅在邀請時收件人 電子郵件地址未知 時使用。 這只在你邀請收件人（不包括準備路線）且你想使用 fastlane 時才有效。 這 customId 讓你能在寄出邀請前，預先生成一個獨特的簽名連結給收件人。 必須是唯一且至少有70個字元的字母數字串。 注意：customId只能用來建立文件的收件人連結。 它不能用於其他請求，而非 memberId。 關於 URL 建構的詳細資訊，請參見「以自訂 ID 開啟文件」
使用Fastlane	useFastlane		boolean	若設定為 ， true 簽署者會在邀請郵件中收到 Fastlane 連結。
phoneNumber	phoneNumber		string	收件人的電話號碼。 這用於簡訊驗證。 （例如：+43 699 1234 1234）。
私人訊息	privateMessage		string	給這位特定收件人的私人訊息。
inPersonMode	inPersonMode		boolean	啟用此選項後，簽名請求的收件人需親自簽署文件，且不會發送電子郵件。 此模式僅適用於 SES 簽章類型
簽名類型	signatureTypes		array of string	該收件人可簽的簽名類型。 選項：['advanced'， 'advancedPlus'， 'qualified'， 'qualifiedPlusIdent'， 'simple']
加標籤	tag		string	此標籤決定將用於簽署程序的身份提供者。 從預設的支援提供者組合中選擇。 註1： 有些供應商僅支援特定簽名類型，例如 onetimeqes 會要求 "signatureType" : ["qualifiedPlusIdent"] 註2： 使用 sproof-qualified 預設提供者時，收件人必須擁有有效的 sproof 帳號且擁有有效的 User+ 授權。
可改變	canChange		boolean	布林值表示受邀收件人是否應該能更改簽名提供者
國家	country		string	預設國家如果是空白，則設為全境，會回傳錯誤，顯示所選提供者標籤可用的國家
截止日期	dueDate		YYYY-MM-DD	文件可簽署的日期。 這個截止日期會在邀請郵件中顯示給收件人，也會在儀表板的文件細節區塊中看到。 它作為完成簽約程序的截止日期。
提醒 間隔	reminderInterval		number	規定提醒郵件之間的天數。
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	提醒應該從哪個日期開始發送
邀請語言	inviteLanguage		string	規定寄給無帳號匿名用戶的電子郵件用語。 對於擁有帳號的用戶，將使用他們在個人資料中選擇的語言。
訊息	message		string	電子郵件中寄給收件人的自訂訊息。
主旨	subject		string	寄給收件人的電子郵件主旨行。
發送完畢PDF（sendOutFinishedPdf）	sendOutFinishedPdf		boolean	若設定為 true，PDF 會作為附件寄送給文件中所有收件人（若檔案大小小於 5MB）。
focusedSigningMode	focusedSigningMode		boolean	啟用此選項後，簽名請求的收件人將只能簽署或拒絕文件，且無法離開頁面。
允許轉發	allowForwarding		boolean	允許轉發邀請函。
協作簽署模式	collabSigningMode		object	一個物件，每個鍵代表一輪簽名，其對應值則表示該輪是否啟用協同簽署。 若該值為真，只需一個簽名即可完成指定的簽名輪並進入下一輪。 例如，{ '1'： true } 表示在簽署 '1' 輪時，只需一個簽名。
inPersonSigning	inPersonSigning		boolean	當符合時，收件人會跳出一個視窗，要求他手動繪製簽名
folderName	folderName		string	若提供，將建立一個包含 documentDataArray 中所有文件的信封。 （若需寄出多份文件）
回調網址	callbackUrl		string	當建立新簽章或收件人拒絕該文件時，會將包含文件的 POST 請求發送至此網址。 若失敗，會設有重試機制以確保請求能被重試。
回轉網址	returnUrl		string	簽署文件後返回按鈕的連結
回傳BtnText	returnBtnText		string	簽署文件後返回按鈕的文字
資料	data	True	string	文件（PDF 或 DOCX）資料以 base64 格式呈現。
模仿類型	mimetype		string	如果文件不是 PDF，則需要 MIME 類型的 base64 編碼資料 PDF 或 DOCX
檔案名稱	fileName	True	string	檔案名稱
標籤	label		string	一個可以寄送來整理文件的自訂標籤。
頁面	page	True	integer	該方框所在的頁面號碼，第一頁為 0。
頁寬	pageWidth		integer	任何描述頁面寬度的整數值。 數字越大，定位盒子在 x y 空間的精確度越高。 在A4紙上，預設值是478。
頁高	pageHeight		integer	任何描述頁面高度的整數值。 數字越大，定位盒子在 x y 空間的精確度越高。 在A4紙上，預設值是676。
x	x	True	float	代表方框的水平位置，以頁面寬度的百分比表示。 原點（0,0）位於頁面左上角。 值為 0.1 表示該框位於頁面寬度的左起 10%。
y	y	True	float	表示方框的垂直位置，以頁面高度的百分比表示。 原點（0,0）位於頁面左上角。 值為 0.1 表示該方框位於頁面高度的 10% 處。
width	width	True	float	根據頁面尺寸計算方框寬度，類似於 x 和 y 座標。 它是一個浮點點，代表頁面寬度的百分比。
height	height	True	float	根據頁面尺寸計算盒子的高度，類似於 x 和 y 座標。 它是一個浮點，代表 pageHeight 的百分比。
id	id	True	string	這個盒子有唯一的 ID，可以隨你怎麼產生。
標籤	label		string	佔位文字，例如欄位名稱，例如「出生日期」。
value	value		string	盒子的預設值。 可以是 null。 若該框型別為「chooseBox」，該值可為空值或選項中定義的字串之一。
唯讀	readonly		boolean	若設為 true，受邀者無法修改此框的值。
required	required		boolean	若設為 true，受邀者必須填寫此框即可簽署文件。
型別	type	True	string
多行	multiline		boolean	是否允許多條線路。
顯示值	displayValue	True	string
出口價值	exportValue	True	string
組成群組	group		number	每個無線電盒都可以分配到一個群組。
簽名類型	signatureTypes		array of string	該收件人允許的簽章類型，可以被接收者簽章類型覆蓋。 選項：['advanced'， 'advancedPlus'， 'qualified'， 'simple'， 'qualifiedPlusIdent']
refId	refId		string	refId 是一個選填欄位，用來交叉比對上傳的文件。 如果有提供，它允許你為文件指派自訂的參考識別碼，該識別碼會在未來的 API 回應中作為文件物件的一部分回傳。 這對於透過外部系統或工作流程追蹤或組織文件非常有用。
語言	language		string	文件語言。
folderId	folderId		string	文件應該插入資料夾的 ID。 這只有在 inviteData 和 folderName 都未定義時才可能。
是附件	isAttachment		boolean	此時不需要 isAttachment。
使用Fastlane	useFastlane		boolean	若設定為 ， true 簽署者會在邀請郵件中收到 Fastlane 連結。
fastlaneProfileId	fastlaneProfileId		uuid	請指定與本文件一起使用的 Fastlane 設定檔。 （useFastlane 必須設為 true）。

傳回

身體

EnvelopeResponse

刪除文件

作業識別碼：

DeleteDocument

刪除文件或移除成員對該文件的存取權限，視所提供的 memberId 文件屬於寄件人或收件人，以及該文件是否屬於信封而定。

信封中文件

查詢參數 all 對信封中的文件沒有影響。

與寄件 memberId人：

• 發送者和所有收件人會刪除一份文件。
• 文件會從信封中取出。

與受獎者 memberId：

• 信封內所有文件都會被收件人取出。
• 收件人在所有為收件人刪除的文件上都會被標記為declined
• 文件仍對文件中其他成員開放。

單一文件

與發送 memberId 者 及 all=true：

• 該文件對寄件人及所有收件人皆已刪除。

與發送 memberId 者 及 all=false：

• 該文件只會被刪除給寄件人使用。
• 該文件仍對其他收件人開放。

與受獎者 memberId：

• 收件人會在文件上標示為declined
• 該文件仍對文件中其他成員開放。

參數

名稱	機碼	必要	類型	Description
會員編號	memberId	True	string	會員編號
刪除 所有收件人	all		boolean	只有在提供文件屬於寄件人時才適用 memberId 。 若設定為 true，該文件會對寄件人及所有收件人一同刪除。 若設定為 false，該文件僅對寄件人可刪除，其他收件人仍可使用。 此參數對信封中的文件（預設 = true）或 memberId 信封屬於收件人時無效。

傳回

response

DeleteDocumentResponse

取得文件

作業識別碼：

GetDocument

以二進位或 Base64 編碼的字串形式簽署文件。

參數

名稱	機碼	必要	類型	Description
會員編號	memberId	True	string	會員編號
下載格式	format		string	規定回應格式。 用於 pdf 二進位 PDF 及 base64 Base64 編碼的回應。 範例 base64 回應： json { "base64": "JVBERi0xLjQKJe..." }

傳回

名稱	路徑	類型	Description
base64	base64	string	Base64 編碼的 PDF 內容

建立簽名請求

作業識別碼：

CreateSignatureRequest

這是新的建立簽名請求。 除了建立單一文件邀請外，現在還支援在發送邀請時建立信封並一次上傳多份文件。

參數

名稱	機碼	必要	類型	Description
電子郵件	email	True	string	寄件人的電子郵件。 必須屬於你保險計畫的成員。
firstName	firstName	True	string	寄件人的名字。
lastName	lastName		string	寄件人的姓氏。
角色	role		string	寄件人在所有文件中的角色。
電子郵件	email		string	收件人的電子郵件。
firstName	firstName		string	收件者的名字。
lastName	lastName		string	收件者的姓氏。
doNotSendEmails	doNotSendEmails		boolean	若設定為 true 無，則會發送電子郵件給收件人。
自訂標識碼	customId		string	僅在邀請時收件人 電子郵件地址未知 時使用。 這只在你邀請收件人（不包括準備路線）且你想使用 fastlane 時才有效。 這 customId 讓你能在寄出邀請前，預先生成一個獨特的簽名連結給收件人。 必須是唯一且至少有70個字元的字母數字串。 注意：customId只能用來建立文件的收件人連結。 它不能用於其他請求，而非 memberId。 關於 URL 建構的詳細資訊，請參見「以自訂 ID 開啟文件」
使用Fastlane	useFastlane		boolean	若設定為 ， true 簽署者會在邀請郵件中收到 Fastlane 連結。
phoneNumber	phoneNumber		string	收件人的電話號碼。 這用於簡訊驗證。 （例如：+43 699 1234 1234）。
私人訊息	privateMessage		string	給這位特定收件人的私人訊息。
inPersonMode	inPersonMode		boolean	啟用此選項後，簽名請求的收件人需親自簽署文件，且不會發送電子郵件。 此模式僅適用於 SES 簽章類型
簽名類型	signatureTypes		array of string	該收件人可簽的簽名類型。 選項：['advanced'， 'advancedPlus'， 'qualified'， 'qualifiedPlusIdent'， 'simple']
加標籤	tag		string	此標籤決定將用於簽署程序的身份提供者。 從預設的支援提供者組合中選擇。 註1： 有些供應商僅支援特定簽名類型，例如 onetimeqes 會要求 "signatureType" : ["qualifiedPlusIdent"] 註2： 使用 sproof-qualified 預設提供者時，收件人必須擁有有效的 sproof 帳號且擁有有效的 User+ 授權。
可改變	canChange		boolean	布林值表示受邀收件人是否應該能更改簽名提供者
國家	country		string	預設國家如果是空白，則設為全境，會回傳錯誤，顯示所選提供者標籤可用的國家
截止日期	dueDate		YYYY-MM-DD	文件可簽署的日期。 這個截止日期會在邀請郵件中顯示給收件人，也會在儀表板的文件細節區塊中看到。 它作為完成簽約程序的截止日期。
提醒 間隔	reminderInterval		number	規定提醒郵件之間的天數。
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	提醒應該從哪個日期開始發送
邀請語言	inviteLanguage		string	規定寄給無帳號匿名用戶的電子郵件用語。 對於擁有帳號的用戶，將使用他們在個人資料中選擇的語言。
訊息	message		string	電子郵件中寄給收件人的自訂訊息。
主旨	subject		string	寄給收件人的電子郵件主旨行。
發送完畢PDF（sendOutFinishedPdf）	sendOutFinishedPdf		boolean	若設定為 true，PDF 會作為附件寄送給文件中所有收件人（若檔案大小小於 5MB）。
focusedSigningMode	focusedSigningMode		boolean	啟用此選項後，簽名請求的收件人將只能簽署或拒絕文件，且無法離開頁面。
允許轉發	allowForwarding		boolean	允許轉發邀請函。
協作簽署模式	collabSigningMode		object	一個物件，每個鍵代表一輪簽名，其對應值則表示該輪是否啟用協同簽署。 若該值為真，只需一個簽名即可完成指定的簽名輪並進入下一輪。 例如，{ '1'： true } 表示在簽署 '1' 輪時，只需一個簽名。
usePlaceholders	usePlaceholders		boolean	如果屬實，文件中儲存的文字佔位符/表單欄位將被用來邀請收件人。
inPersonSigning	inPersonSigning		boolean	當符合時，收件人會跳出一個視窗，要求他手動繪製簽名
folderName	folderName		string	若提供，將建立一個包含 documentDataArray 中所有文件的信封。 （若需寄出多份文件）
回調網址	callbackUrl		string	當建立新簽章或收件人拒絕該文件時，會將包含文件的 POST 請求發送至此網址。 若失敗，會設有重試機制以確保請求能被重試。
回轉網址	returnUrl		string	簽署文件後返回按鈕的連結
回傳BtnText	returnBtnText		string	簽署文件後返回按鈕的文字
資料	data	True	string	文件（PDF 或 DOCX）資料以 base64 格式呈現。
模仿類型	mimetype		string	如果文件不是 PDF，則需要 MIME 類型的 base64 編碼資料 PDF 或 DOCX
檔案名稱	fileName	True	string	檔案名稱
標籤	label		string	一個可以寄送來整理文件的自訂標籤。
頁面	page	True	integer	該方框所在的頁面號碼，第一頁為 0。
頁寬	pageWidth		integer	任何描述頁面寬度的整數值。 數字越大，定位盒子在 x y 空間的精確度越高。 在A4紙上，預設值是478。
頁高	pageHeight		integer	任何描述頁面高度的整數值。 數字越大，定位盒子在 x y 空間的精確度越高。 在A4紙上，預設值是676。
x	x	True	float	代表方框的水平位置，以頁面寬度的百分比表示。 原點（0,0）位於頁面左上角。 值為 0.1 表示該框位於頁面寬度的左起 10%。
y	y	True	float	表示方框的垂直位置，以頁面高度的百分比表示。 原點（0,0）位於頁面左上角。 值為 0.1 表示該方框位於頁面高度的 10% 處。
width	width	True	float	根據頁面尺寸計算方框寬度，類似於 x 和 y 座標。 它是一個浮點點，代表頁面寬度的百分比。
height	height	True	float	根據頁面尺寸計算盒子的高度，類似於 x 和 y 座標。 它是一個浮點，代表 pageHeight 的百分比。
id	id	True	string	這個盒子有唯一的 ID，可以隨你怎麼產生。
標籤	label		string	佔位文字，例如欄位名稱，例如「出生日期」。
value	value		string	盒子的預設值。 可以是 null。 若該框型別為「chooseBox」，該值可為空值或選項中定義的字串之一。
唯讀	readonly		boolean	若設為 true，受邀者無法修改此框的值。
required	required		boolean	若設為 true，受邀者必須填寫此框即可簽署文件。
型別	type	True	string
多行	multiline		boolean	是否允許多條線路。
顯示值	displayValue	True	string
出口價值	exportValue	True	string
組成群組	group		number	每個無線電盒都可以分配到一個群組。
簽名類型	signatureTypes		array of string	該收件人允許的簽章類型，可以被接收者簽章類型覆蓋。 選項：['advanced'， 'advancedPlus'， 'qualified'， 'simple'， 'qualifiedPlusIdent']
refId	refId		string	refId 是一個選填欄位，用來交叉比對上傳的文件。 如果有提供，它允許你為文件指派自訂的參考識別碼，該識別碼會在未來的 API 回應中作為文件物件的一部分回傳。 這對於透過外部系統或工作流程追蹤或組織文件非常有用。
語言	language		string	文件語言。
folderId	folderId		string	文件應該插入資料夾的 ID。 這只有在 inviteData 和 folderName 都未定義時才可能。
是附件	isAttachment		boolean	此時不需要 isAttachment。
收件者詳細資料	recipientDetails	True	object	收件人資料依收件人電子郵件鍵入。 範例：{“mail@test.com”：{“role”：signer“，”signaturePositions“：[{”page“：0，”x“：0.55，”y“：0.80，”width“：0.25，”height“：0.08}]}}。
使用Fastlane	useFastlane		boolean	若設定為 ， true 簽署者會在邀請郵件中收到 Fastlane 連結。
fastlaneProfileId	fastlaneProfileId		uuid	請指定與本文件一起使用的 Fastlane 設定檔。 （useFastlane 必須設為 true）。

傳回

身體

EnvelopeResponse

查詢請求狀態

作業識別碼：

GetSignatureStatus

查詢簽名請求的狀態。 回傳文件 JSON 物件或錯誤訊息。 該參數由文件上的郵件請求回傳，並與寄件者的電子郵件相關聯。

參數

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

傳回

身體

DocumentStatusForFlow

定義

刪除文件回應

刪除文件回應

string

包絡響應

名稱	路徑	類型	Description
folderId	folderId	string
folderName	folderName	string
文件	documents	array of object
id	documents.id	string
名字	documents.name	string
語言	documents.language	string
startSendingReminders	documents.startSendingReminders	date-time	提醒開始發送的日期與時間（ISO 8601 日期時間字串）
發送提醒	documents.sendReminder	boolean
提醒已發送	documents.reminderSent	boolean
提醒 間隔	documents.reminderInterval	number
createdAt	documents.createdAt	date-time	文件建立的日期與時間（ISO 8601 日期時間字串）
回調網址	documents.callbackUrl	string
回轉網址	documents.returnUrl	string
回傳BtnText	documents.returnBtnText	string
inPersonSigning	documents.inPersonSigning	boolean
簽約輪	documents.signingRound	number
是模板	documents.isTemplate	boolean
templateId	documents.templateId	string
linkId	documents.linkId	string
連結過期於	documents.linkExpiresAt	string
衍生自連結	documents.derivedFromLink	boolean
狀態	documents.state	string
complianceLevel	documents.complianceLevel	string
允許轉發	documents.allowForwarding	boolean
連結 過期	documents.linkExpires	boolean
setDueDate	documents.setDueDate	boolean
截止日期	documents.dueDate	date-time	文件截止日期（ISO 8601 日期時間字串）
focusedSigningMode	documents.focusedSigningMode	boolean
連結MaxSignaturesEnabled	documents.linkMaxSignaturesEnabled	boolean
連結Max簽名	documents.linkMaxSignatures	number
fastlaneProfileId	documents.fastlaneProfileId	string
refId	documents.refId	string
發送完畢PDF（sendOutFinishedPdf）	documents.sendOutFinishedPdf	boolean
簽名類型	documents.signatureTypes	array of string
members	documents.members	array of MemberResponseSchema
成員	documents.member	MemberResponseSchema
盒子	documents.boxes	array of DocumentResponseBox	文件回應中的表單欄位框。 只有當文件有表單欄位時才會回傳此欄位。 如果文件已簽署，文件會回傳包含已填寫值的方框。
遲到的	documents.overdue	boolean

文件回應框

名稱	路徑	類型	Description
id	id	string
型別	type	string
value	value	string	盒子欄位的值。 可以是字串（包含空字串）、布林值或空值，視盒子類型而定。
標籤	label	string

成員回應架構

名稱	路徑	類型	Description
id	id	string
documentId	documentId	string
電子郵件	email	string
firstName	firstName	string
lastName	lastName	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time	成員建立的日期與時間（ISO 8601 日期時間字串）
sendDeleteNotificationAt	sentDeleteNotificationAt	date-time	刪除通知發出的日期與時間（ISO 8601 日期時間字串）
manuallyLastEmailSent	manuallyLastEmailSent	date-time	最後一封手動郵件發送的日期與時間（ISO 8601 日期時間字串）
簽名職位	signaturePosition	MemberSignaturePositionResponse	簽名位置資料，並附有針對回應的額外欄位。 cardStyle、pageWidth 和 pageHeight 欄位為可選，並非所有 API 回應皆有。
doNotSendEmails	doNotSendEmails	boolean
拒絕了	declinedAt	date-time	會員拒絕的日期與時間（ISO 8601 日期時間字串）
簽署命令	signingOrder	number
隨選視訊	onDemand	string
recipientId	recipientId	string
簽名類型	signatureTypes	array of string
signatureTypesActive	signatureTypesActive	boolean
私人訊息	privateMessage	string
自訂標識碼	customId	string
使用Fastlane	useFastlane	boolean
角色	role	string
核准於	approvedAt	date-time	會員獲批的日期與時間（ISO 8601 日期時間字串）
verificationConfig	verificationConfig
phoneNumber	phoneNumber	string
簽名	signatures	array of string
signed在	signedAt	date-time	成員簽署的日期與時間（ISO 8601 日期時間字串）

成員簽名 職位回應

簽名位置資料，並附有針對回應的額外欄位。 cardStyle、pageWidth 和 pageHeight 欄位為可選，並非所有 API 回應皆有。

名稱	路徑	類型	Description
物品		SignaturePositionResponse	簽名位置資料，並附有針對回應的額外欄位。 cardStyle、pageWidth 和 pageHeight 欄位為可選，並非所有 API 回應皆有。

簽名位置回應

簽名位置資料，並附有針對回應的額外欄位。 cardStyle、pageWidth 和 pageHeight 欄位為可選，並非所有 API 回應皆有。

名稱	路徑	類型	Description
頁面	page	integer	頁碼，從0開始。
x	x	number	簽名左上角位置的座標
y	y	number	簽名左上角位置的 y 座標
width	width	number	簽名的寬度。
height	height	number	簽名高度。
cardStyle	cardStyle	string	簽名卡的視覺風格。 此欄位為可選，且不可能在所有回應中回傳。
頁寬	pageWidth	number	頁面寬度（以像素為單位）。 此欄位為可選，且不可能在所有回應中回傳。
頁高	pageHeight	number	頁面高度（像素單位）。 此欄位為可選，且不可能在所有回應中回傳。

DocumentStatusForFlow

名稱	路徑	類型	Description
id	id	string
名字	name	string
狀態	state	string	文件目前的狀態。 可能的值包括：草稿、待處理、拒絕、已完成、附件、手動待定、手動完成
createdAt	createdAt	date
updatedAt	updatedAt	date
所有簽名者簽名	allSignersSigned	boolean
全體成員簽名	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean