sproof Sign (プレビュー)

PDF および DOCX ドキュメントの安全な電子署名ワークフローを自動化するには、確実な署名を使用します。組織は、単一または複数のドキュメント署名要求の作成、受信者と署名ロールの割り当て、状態の追跡、完了した PDF のダウンロード、ドキュメントの削除を行うことができます。確実な署名アカウント、選択したアクションと署名の種類をサポートするプラン、および有効な API トークンが必要です。

このコネクタは、次の製品とリージョンで使用できます。

Service	クラス	リージョン
コピロットスタジオ	Premium	次を除くすべてのPower Automateリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD)
ロジックアプリ	Standard	次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD)
Power Apps	Premium	次を除くすべてのPower Appsリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD)
Power Automate（パワーオートメート）	Premium	次を除くすべてのPower Automateリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD)

連絡先
名前	API サポート
URL	https://sproof.com
Email	support@sproof.com

コネクタメタデータ
パブリッシャー	sproof GmbH
Web サイト	https://www.sproof.com/en/sign/
プライバシーポリシー	https://www.sproof.com/en/privacy-policy-app/
カテゴリ	生産性;コンテンツとファイル

防弾サイン

Overview

Sproof Sign を使用すると、組織は PDF および DOCX ドキュメントの電子署名ワークフローを自動化できます。コネクタでは、単一ドキュメント署名要求または複数ドキュメントエンベロープの作成、受信者と署名ロールの割り当て、要求の状態の取得、完了したドキュメントのダウンロード、ドキュメントの削除を行うことができます。

前提条件

コネクタを使用するには、次のものが必要です。

確実な署名アカウント。
必要なアクションと署名の種類に対する API アクセスとサポートを備えた、確実な署名プラン。
有効な確実な署名 API トークン。

Authentication

コネクタは API トークン認証を使用します。アカウントに関連付けられている有効な署名 API トークンを入力して、接続を作成します。トークンを安全に保ち、取り消されたり再生成されたりした場合は、トークンを置き換えます。

サポートされているアクション

署名要求の作成 - 1 つのドキュメントまたは複数のドキュメントを含む封筒の要求を作成します。受信者、署名ロール、署名順序、署名の位置、およびその他の招待設定を構成できます。
プレースホルダーを使用して署名要求を作成する - アップロードされたドキュメントに格納されているプレースホルダーを使用して要求を作成します。受信者の情報と署名の位置は、これらのプレースホルダーから抽出されます。
要求の状態の取得 - メンバー ID を使用して、署名要求の現在の状態と署名状態を取得します。
ドキュメントの取得 - バイナリ PDF または Base64 でエンコードされた PDF としてドキュメントをダウンロードします。
ドキュメントの削除 - 指定されたメンバー ID、メンバーのロール、ドキュメントが封筒に属しているかどうかに応じて、ドキュメントを削除するか、メンバーのアクセス権を削除します。

既知の制限事項と要件

入力ドキュメントは、Base64 でエンコードされた PDF または DOCX コンテンツとして提供する必要があります。
封筒には最大 25 個のドキュメントを含めることができます。
複数のドキュメントを提出する場合は、封筒名が必要です。
プレースホルダーベースの要求では、アップロードされたドキュメントで正しく書式設定されたプレースホルダーが必要です。
プレースホルダーベースの要求の場合、受信者と署名の位置は、手動で入力するのではなく、ドキュメントから取得されます。
使用可能なアクション、署名の種類、プロバイダーは、接続されている確実な署名アカウントとプランによって異なります。
ドキュメントの削除動作は、指定されたメンバー ID が送信者または受信者に属しているかどうか、およびドキュメントがエンベロープの一部であるかどうかによって異なります。

Support

コネクタまたは API のサポートについては、 support@sproof.comにお問い合わせください。

接続を作成する

コネクタでは、次の認証の種類がサポートされています。


デフォルト	接続を作成するためのパラメーター。	すべてのリージョン	共有不可

デフォルト

適用対象: すべてのリージョン

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前	タイプ	Description	必須
トークン	securestring	"token" für diese API	True

アクション

ドキュメントを削除する	指定された `memberId` が送信者と受信者のどちらに属しているか、ドキュメントが封筒の一部であるかどうかに応じて、ドキュメントを削除するか、メンバーのアクセス権を削除します。封筒内のドキュメントクエリパラメーター `all` は、エンベロープ内のドキュメントには影響しません。送信者の `memberId`: 送信者とすべての受信者の 1 つのドキュメントが削除されます。文書は封筒から削除されます。受信者の `memberId`: 封筒内のすべてのドキュメントは、受信者に対して削除されます。受信者は、受信者に対して削除されたすべてのドキュメントで `declined` としてマークされます。ドキュメントは、ドキュメントの他のすべてのメンバーに対して引き続き使用できます。 1 つのドキュメント送信者の `memberId` と `all=true`: 送信者とすべての受信者のドキュメントが削除されます。送信者の `memberId` と `all=false`: ドキュメントは送信者に対してのみ削除されます。ドキュメントは、ドキュメントの他の受信者に対して引き続き使用できます。受信者の `memberId`: 受信者は、ドキュメントに `declined` としてマークされます。ドキュメントは、ドキュメントの他のすべてのメンバーに対して引き続き使用できます。
ドキュメントを取得する	署名されたドキュメントをバイナリまたは Base64 でエンコードされた文字列として取得します。
プレースホルダーを使用して署名要求を作成する	アップロードされたドキュメントに格納されているプレースホルダーを使用して署名要求を作成します。受信者と署名の位置は、ドキュメントから抽出されます。
署名要求を作成する	これは、新しい署名の作成要求です。 1 つのドキュメントへの招待を作成するだけでなく、招待状を送信するときに封筒を作成し、複数のドキュメントを一度にアップロードできるようになりました。
要求の状態を取得する	署名要求の状態を取得します。ドキュメント JSON オブジェクトまたはエラーを返します。このパラメーターは、ドキュメントの投稿要求によって返され、送信者の電子メールに関連付けられます。

ドキュメントを削除する

操作 ID:: DeleteDocument

指定された memberId が送信者と受信者のどちらに属しているか、ドキュメントが封筒の一部であるかどうかに応じて、ドキュメントを削除するか、メンバーのアクセス権を削除します。

封筒内のドキュメント

クエリパラメーター all は、エンベロープ内のドキュメントには影響しません。

送信者の memberId:

送信者とすべての受信者の 1 つのドキュメントが削除されます。
文書は封筒から削除されます。

受信者の memberId:

封筒内のすべてのドキュメントは、受信者に対して削除されます。
受信者は、受信者に対して削除されたすべてのドキュメントで declined としてマークされます。
ドキュメントは、ドキュメントの他のすべてのメンバーに対して引き続き使用できます。

1 つのドキュメント

送信者の memberId と all=true:

送信者とすべての受信者のドキュメントが削除されます。

送信者の memberId と all=false:

ドキュメントは送信者に対してのみ削除されます。
ドキュメントは、ドキュメントの他の受信者に対して引き続き使用できます。

受信者の memberId:

受信者は、ドキュメントに declined としてマークされます。
ドキュメントは、ドキュメントの他のすべてのメンバーに対して引き続き使用できます。

パラメーター

名前	キー	必須	型	説明
メンバー ID	memberId	True	string	メンバー ID
すべての受信者の削除	all		boolean	指定された `memberId` が送信者に属している場合にのみ、単一のドキュメントに関連します。 `true`に設定すると、送信者とすべての受信者のドキュメントが削除されます。 `false`に設定した場合、ドキュメントは送信者に対してのみ削除され、他の受信者は引き続き使用できます。このパラメーターは、封筒内のドキュメント (既定値 = `true`) や、指定された `memberId` が受信者に属している場合には影響しません。

返品

response: DeleteDocumentResponse

ドキュメントを取得する

操作 ID:: GetDocument

署名されたドキュメントをバイナリまたは Base64 でエンコードされた文字列として取得します。

パラメーター

名前	キー	必須	型	説明
メンバー ID	memberId	True	string	メンバー ID
ダウンロード形式	format		string	応答の形式を指定します。バイナリ PDF には `pdf` を使用し、Base64 でエンコードされた応答には `base64` を使用します。 `base64`応答の例:`json { "base64": "JVBERi0xLjQKJe..." }`

返品

名前	パス	型	説明
base64	base64	string	Base64 でエンコードされた PDF コンテンツ

プレースホルダーを使用して署名要求を作成する

操作 ID:: CreateSignatureRequestUsingPlaceholders

アップロードされたドキュメントに格納されているプレースホルダーを使用して署名要求を作成します。受信者と署名の位置は、ドキュメントから抽出されます。

パラメーター

名前	キー	必須	型	説明
メール	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	customId		string	招待時に受信者のメールアドレスが不明な場合にのみ使用します。これは、受信者を招待して (ルートの準備ではなく) fastlane を使用する場合にのみ機能します。 `customId`を使用すると、招待を送信する前に、受信者の一意の署名リンクを事前に生成できます。 70 文字以上の一意の英数字文字列である必要があります。注: customId は、ドキュメントへの受信者リンクの作成にのみ使用できます。 memberId の代わりに他の要求には使用できません。 URL の構築の詳細については、「カスタム ID を使用してドキュメントを開く」を参照してください。
useFastlane	useFastlane		boolean	`true`に設定すると、署名者は招待メールに Fastlane リンクを受信します。
phoneNumber	phoneNumber		string	この受信者の電話番号。これは SMS 検証に使用されます。 (例: +43 699 1234 1234)。
privateMessage	privateMessage		string	この特定の受信者のプライベートメッセージ。
inPersonMode	inPersonMode		boolean	このオプションが有効になっている場合、署名要求の受信者は、ドキュメントにサインインする必要があり、電子メールは送信されません。このモードは、SES 署名の種類を使用してのみ使用できます
signatureTypes	signatureTypes		array of string	この受信者に対して許可される署名の種類。オプション: ['advanced'、'advancedPlus'、'qualified'、'qualifiedPlusIdent'、'simple']
タグ	tag		string	このタグは、署名プロセスに使用される ID プロバイダーを決定します。サポートされているプロバイダーの定義済みのセットから選択します。注 1:一部のプロバイダーは、特定の signatureTypes でのみ使用できます。たとえば、`onetimeqes"signatureType" : ["qualifiedPlusIdent"]` 注 2:`sproof-qualified`を既定のプロバイダーとして使用する場合、受信者はアクティブな User+ ライセンスを持つアクティブな耐用アカウントを持っている必要があります。
canChange	canChange		boolean	招待された受信者が署名プロバイダーを変更できるかどうかを示すブール値
country	country		string	既定の国。空白の場合、すべての国に設定されている場合は、選択したプロバイダータグで使用可能な国でエラーが返されます
期日	dueDate		YYYY-MM-DD	ドキュメントに署名できる日付。この期限は、招待メールの受信者に表示され、ダッシュボードのドキュメントの詳細セクションにも表示されます。これは、署名プロセスを完了するための期限として機能します。
reminderInterval	reminderInterval		number	アラームメール間の日数を指定します。
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	アラームを送信する日付
inviteLanguage	inviteLanguage		string	アカウントを持たない匿名ユーザーに送信されるメールの言語を指定します。アカウントを持つユーザーの場合、プロファイルで選択した言語が代わりに使用されます。
メッセージ	message		string	メール内の受信者に送信されるカスタムメッセージ。
件名	subject		string	受信者に送信された電子メールの件名行。
sendOutFinishedPdf	sendOutFinishedPdf		boolean	true に設定すると、pdf はドキュメント上のすべての受信者に添付ファイルとして送信されます (5 MB 未満の場合)。
focusedSigningMode	focusedSigningMode		boolean	このオプションを有効にすると、署名要求の受信者はドキュメントの署名または拒否に制限され、ページから移動できなくなります。
allowForwarding	allowForwarding		boolean	招待の転送を許可します。
collabSigningMode	collabSigningMode		object	各キーが署名ラウンドを表し、対応する値がそのラウンドに対してコラボレーション署名が有効になっているかどうかを示すオブジェクト。値が true の場合、指定した署名ラウンドを完了して次のラウンドに進むには、1 つの署名のみが必要です。たとえば、{ '1': true } は、ラウンド '1' の署名では 1 つの署名のみが必要であることを意味します。
inPersonSigning	inPersonSigning		boolean	true の場合、受信者は手動で署名を描画する必要があるポップアップを取得します
folderName	folderName		string	指定すると、documentDataArray 内のすべてのドキュメントを含む封筒が作成されます。 (複数のドキュメントが送信される場合は必須)
コールバックURL	callbackUrl		string	ドキュメントを含む POST 要求は、新しい署名が作成されたとき、または受信者がドキュメントを辞退したときに、この URL に送信されます。エラーが発生した場合は、要求が再試行されるように再試行メカニズムが用意されています。
returnUrl	returnUrl		string	ドキュメントに署名した後の [戻る] ボタンのリンク
returnBtnText	returnBtnText		string	ドキュメントに署名した後の [戻る] ボタンのテキスト
データ	data	True	string	base64 形式のドキュメント (PDF または DOCX) データ。
mimetype	mimetype		string	ドキュメントが PDF でない場合に必要な base64 でエンコードされたデータ PDF または DOCX の MIME の種類
ファイル名	fileName	True	string	ファイルの名前
ラベル	label		string	ドキュメントを整理するために送信できるカスタムラベル。
ページ	page	True	integer	ボックスが表示されているページの番号。最初のページは 0 です。
pageWidth	pageWidth		integer	ページ幅を記述する任意の整数値。数値が大きいほど、ボックスを x y 空間に配置するときの精度が向上します。 A4 ページでは、既定値として 478 があります。
pageHeight	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 座標と同様に、ページの寸法に基づくボックスの幅。 pageWidth の割合を表す浮動小数点数です。
height	height	True	float	x 座標と y 座標に似た、ページの寸法に基づくボックスの高さ。 pageHeight の割合を表す浮動小数点数です。
id	id	True	string	このボックスの一意の ID。任意の方法で生成されます。
ラベル	label		string	フィールドの名前などのプレースホルダーテキスト (例: "Date of Birth")。
value	value		string	ボックスの既定値。 null を指定できます。ボックスが 'chooseBox' 型の場合、値は null またはオプションで定義されている文字列のいずれかになります。
readonly	readonly		boolean	true に設定すると、招待されたユーザーはこのボックスの値を変更できません。
required	required		boolean	true に設定すると、招待されたユーザーは、このボックスに入力しないとドキュメントに署名できません。
型	type	True	string
multiline	multiline		boolean	複数の行を許可するかどうかを指定します。
displayValue	displayValue	True	string
exportValue	exportValue	True	string
グループ	group		number	各ラジオボックスをグループに割り当てることができます。
signatureTypes	signatureTypes		array of string	この受信者に許可されている署名の種類は、受信者の署名の種類によって上書きできます。オプション: ['advanced'、'advancedPlus'、'qualified'、'simple'、'qualifiedPlusIdent']
refId	refId		string	refId は、アップロードされたドキュメントを相互参照するために使用される省略可能なフィールドです。指定した場合は、カスタム参照識別子をドキュメントに割り当てることができます。これは、今後の API 応答でドキュメントオブジェクトの一部として返されます。これは、外部システムまたはワークフローによるドキュメントの追跡または整理に役立ちます。
言語	language		string	ドキュメント言語。
folderId	folderId		string	ドキュメントを挿入するフォルダーの ID。これは、inviteData と folderName の両方が未定義の場合にのみ可能です。
isAttachment	isAttachment		boolean	この場合、isAttachment は必要ありません。
useFastlane	useFastlane		boolean	`true`に設定すると、署名者は招待メールに Fastlane リンクを受信します。
fastlaneProfileId	fastlaneProfileId		uuid	このドキュメントで使用する Fastlane プロファイルを指定します。 (useFastlane を true に設定する必要があります)。

返品

Body: EnvelopeResponse

署名要求を作成する

操作 ID:: CreateSignatureRequest

これは、新しい署名の作成要求です。 1 つのドキュメントへの招待を作成するだけでなく、招待状を送信するときに封筒を作成し、複数のドキュメントを一度にアップロードできるようになりました。

パラメーター

名前	キー	必須	型	説明
メール	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	customId		string	招待時に受信者のメールアドレスが不明な場合にのみ使用します。これは、受信者を招待して (ルートの準備ではなく) fastlane を使用する場合にのみ機能します。 `customId`を使用すると、招待を送信する前に、受信者の一意の署名リンクを事前に生成できます。 70 文字以上の一意の英数字文字列である必要があります。注: customId は、ドキュメントへの受信者リンクの作成にのみ使用できます。 memberId の代わりに他の要求には使用できません。 URL の構築の詳細については、「カスタム ID を使用してドキュメントを開く」を参照してください。
useFastlane	useFastlane		boolean	`true`に設定すると、署名者は招待メールに Fastlane リンクを受信します。
phoneNumber	phoneNumber		string	この受信者の電話番号。これは SMS 検証に使用されます。 (例: +43 699 1234 1234)。
privateMessage	privateMessage		string	この特定の受信者のプライベートメッセージ。
inPersonMode	inPersonMode		boolean	このオプションが有効になっている場合、署名要求の受信者は、ドキュメントにサインインする必要があり、電子メールは送信されません。このモードは、SES 署名の種類を使用してのみ使用できます
signatureTypes	signatureTypes		array of string	この受信者に対して許可される署名の種類。オプション: ['advanced'、'advancedPlus'、'qualified'、'qualifiedPlusIdent'、'simple']
タグ	tag		string	このタグは、署名プロセスに使用される ID プロバイダーを決定します。サポートされているプロバイダーの定義済みのセットから選択します。注 1:一部のプロバイダーは、特定の signatureTypes でのみ使用できます。たとえば、`onetimeqes"signatureType" : ["qualifiedPlusIdent"]` 注 2:`sproof-qualified`を既定のプロバイダーとして使用する場合、受信者はアクティブな User+ ライセンスを持つアクティブな耐用アカウントを持っている必要があります。
canChange	canChange		boolean	招待された受信者が署名プロバイダーを変更できるかどうかを示すブール値
country	country		string	既定の国。空白の場合、すべての国に設定されている場合は、選択したプロバイダータグで使用可能な国でエラーが返されます
期日	dueDate		YYYY-MM-DD	ドキュメントに署名できる日付。この期限は、招待メールの受信者に表示され、ダッシュボードのドキュメントの詳細セクションにも表示されます。これは、署名プロセスを完了するための期限として機能します。
reminderInterval	reminderInterval		number	アラームメール間の日数を指定します。
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	アラームを送信する日付
inviteLanguage	inviteLanguage		string	アカウントを持たない匿名ユーザーに送信されるメールの言語を指定します。アカウントを持つユーザーの場合、プロファイルで選択した言語が代わりに使用されます。
メッセージ	message		string	メール内の受信者に送信されるカスタムメッセージ。
件名	subject		string	受信者に送信された電子メールの件名行。
sendOutFinishedPdf	sendOutFinishedPdf		boolean	true に設定すると、pdf はドキュメント上のすべての受信者に添付ファイルとして送信されます (5 MB 未満の場合)。
focusedSigningMode	focusedSigningMode		boolean	このオプションを有効にすると、署名要求の受信者はドキュメントの署名または辞退に制限され、ページから移動できなくなります。
allowForwarding	allowForwarding		boolean	招待の転送を許可します。
collabSigningMode	collabSigningMode		object	各キーが署名ラウンドを表し、対応する値がそのラウンドに対してコラボレーション署名が有効になっているかどうかを示すオブジェクト。値が true の場合、指定した署名ラウンドを完了して次のラウンドに進むには、1 つの署名のみが必要です。たとえば、{ '1': true } は、ラウンド '1' の署名では、1 つの署名のみが必要であることを意味します。
usePlaceholders	usePlaceholders		boolean	true の場合、ドキュメントに格納されているテキストプレースホルダー/formFields は、受信者を招待するために使用されます。
inPersonSigning	inPersonSigning		boolean	true の場合、受信者は手動で署名を描画する必要があるポップアップを取得します
folderName	folderName		string	指定すると、documentDataArray 内のすべてのドキュメントを含む封筒が作成されます。 (複数のドキュメントが送信される場合は必須)
コールバックURL	callbackUrl		string	ドキュメントを含む POST 要求は、新しい署名が作成されたとき、または受信者がドキュメントを辞退したときに、この URL に送信されます。エラーが発生した場合は、要求が再試行されるように再試行メカニズムが用意されています。
returnUrl	returnUrl		string	ドキュメントに署名した後の [戻る] ボタンのリンク
returnBtnText	returnBtnText		string	ドキュメントに署名した後の [戻る] ボタンのテキスト
データ	data	True	string	base64 形式のドキュメント (PDF または DOCX) データ。
mimetype	mimetype		string	ドキュメントが PDF でない場合に必要な base64 でエンコードされたデータ PDF または DOCX の MIME の種類
ファイル名	fileName	True	string	ファイルの名前
ラベル	label		string	ドキュメントを整理するために送信できるカスタムラベル。
ページ	page	True	integer	ボックスが表示されているページの番号。最初のページは 0 です。
pageWidth	pageWidth		integer	ページ幅を記述する任意の整数値。数値が大きいほど、ボックスを x y 空間に配置するときの精度が向上します。 A4 ページでは、既定値として 478 があります。
pageHeight	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 座標と同様に、ページの寸法に基づくボックスの幅。 pageWidth の割合を表す浮動小数点数です。
height	height	True	float	x 座標と y 座標に似た、ページの寸法に基づくボックスの高さ。 pageHeight の割合を表す浮動小数点数です。
id	id	True	string	このボックスの一意の ID。任意の方法で生成されます。
ラベル	label		string	フィールドの名前などのプレースホルダーテキスト (例: "Date of Birth")。
value	value		string	ボックスの既定値。 null を指定できます。ボックスが 'chooseBox' 型の場合、値は null またはオプションで定義されている文字列のいずれかになります。
readonly	readonly		boolean	true に設定すると、招待されたユーザーはこのボックスの値を変更できません。
required	required		boolean	true に設定すると、招待されたユーザーは、このボックスに入力しないとドキュメントに署名できません。
型	type	True	string
multiline	multiline		boolean	複数の行を許可するかどうかを指定します。
displayValue	displayValue	True	string
exportValue	exportValue	True	string
グループ	group		number	各ラジオボックスをグループに割り当てることができます。
signatureTypes	signatureTypes		array of string	この受信者に許可されている署名の種類は、受信者の署名の種類によって上書きできます。オプション: ['advanced'、'advancedPlus'、'qualified'、'simple'、'qualifiedPlusIdent']
refId	refId		string	refId は、アップロードされたドキュメントを相互参照するために使用される省略可能なフィールドです。指定した場合は、カスタム参照識別子をドキュメントに割り当てることができます。これは、今後の API 応答でドキュメントオブジェクトの一部として返されます。これは、外部システムまたはワークフローによるドキュメントの追跡または整理に役立ちます。
言語	language		string	ドキュメント言語。
folderId	folderId		string	ドキュメントを挿入するフォルダーの ID。これは、inviteData と folderName の両方が未定義の場合にのみ可能です。
isAttachment	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}]}}
useFastlane	useFastlane		boolean	`true`に設定すると、署名者は招待メールに Fastlane リンクを受信します。
fastlaneProfileId	fastlaneProfileId		uuid	このドキュメントで使用する Fastlane プロファイルを指定します。 (useFastlane を true に設定する必要があります)。

返品

Body: EnvelopeResponse

要求の状態を取得する

操作 ID:: GetSignatureStatus

署名要求の状態を取得します。ドキュメント JSON オブジェクトまたはエラーを返します。このパラメーターは、ドキュメントの投稿要求によって返され、送信者の電子メールに関連付けられます。

パラメーター

名前	キー	必須	型	説明
メンバー ID	memberId	True	string	メンバー ID

返品

Body: DocumentStatusForFlow

定義

DeleteDocumentResponse

ドキュメントの応答を削除する: string

EnvelopeResponse

名前	パス	型	説明
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 datetime 文字列)
sendReminder	documents.sendReminder	boolean
reminderSent	documents.reminderSent	boolean
reminderInterval	documents.reminderInterval	number
createdAt	documents.createdAt	date-time	ドキュメントが作成された日時 (ISO 8601 datetime 文字列)
コールバックURL	documents.callbackUrl	string
returnUrl	documents.returnUrl	string
returnBtnText	documents.returnBtnText	string
inPersonSigning	documents.inPersonSigning	boolean
signingRound	documents.signingRound	number
isTemplate	documents.isTemplate	boolean
templateId	documents.templateId	string
linkId	documents.linkId	string
linkExpiresAt	documents.linkExpiresAt	string
derivedFromLink	documents.derivedFromLink	boolean
状態	documents.state	string
complianceLevel	documents.complianceLevel	string
allowForwarding	documents.allowForwarding	boolean
linkExpires	documents.linkExpires	boolean
setDueDate	documents.setDueDate	boolean
期日	documents.dueDate	date-time	ドキュメントの期限 (ISO 8601 datetime 文字列)
focusedSigningMode	documents.focusedSigningMode	boolean
linkMaxSignaturesEnabled	documents.linkMaxSignaturesEnabled	boolean
linkMaxSignatures	documents.linkMaxSignatures	number
fastlaneProfileId	documents.fastlaneProfileId	string
refId	documents.refId	string
sendOutFinishedPdf	documents.sendOutFinishedPdf	boolean
signatureTypes	documents.signatureTypes	array of string
メンバー	documents.members	array of MemberResponseSchema
メンバー	documents.member	MemberResponseSchema
ボックス	documents.boxes	array of DocumentResponseBox	ドキュメント応答のフォームフィールドボックス。これは、ドキュメントにフォームフィールドがある場合にのみ返されます。ドキュメントが署名されている場合、ドキュメントは入力された値を含むボックスを返します。
延滞	documents.overdue	boolean

DocumentResponseBox

名前	パス	型	説明
id	id	string
型	type	string
value	value	string	ボックスフィールドの値。ボックスの種類に応じて、文字列 (空の文字列を含む)、ブール値、または null を指定できます。
ラベル	label	string

MemberResponseSchema

名前	パス	型	説明
id	id	string
documentId	documentId	string
メール	email	string
firstName	firstName	string
lastName	lastName	string
isAdminの	isAdmin	boolean
createdAt	createdAt	date-time	メンバーが作成された日時 (ISO 8601 datetime 文字列)
sentDeleteNotificationAt	sentDeleteNotificationAt	date-time	削除通知が送信された日時 (ISO 8601 datetime 文字列)
manuallyLastEmailSent	manuallyLastEmailSent	date-time	最後の手動電子メールが送信された日時 (ISO 8601 datetime 文字列)
signaturePosition	signaturePosition	MemberSignaturePositionResponse	追加の応答固有フィールドを含む署名位置データ。 cardStyle、pageWidth、pageHeight フィールドは省略可能であり、すべての API 応答に存在しない場合があります。
doNotSendEmails	doNotSendEmails	boolean
declinedAt	declinedAt	date-time	メンバーが辞退した日時 (ISO 8601 datetime 文字列)
signingOrder	signingOrder	number
オンデマンド	onDemand	string
recipientId (受取人ID)	recipientId	string
signatureTypes	signatureTypes	array of string
signatureTypesActive	signatureTypesActive	boolean
privateMessage	privateMessage	string
customId	customId	string
useFastlane	useFastlane	boolean
ロール	role	string
approvedAt	approvedAt	date-time	メンバーが承認された日時 (ISO 8601 datetime 文字列)
verificationConfig(検証設定)	verificationConfig
phoneNumber	phoneNumber	string
署名	signatures	array of string
signedAt	signedAt	date-time	メンバーが署名された日時 (ISO 8601 datetime 文字列)

MemberSignaturePositionResponse

追加の応答固有フィールドを含む署名位置データ。 cardStyle、pageWidth、pageHeight フィールドは省略可能であり、すべての API 応答に存在しない場合があります。

名前	パス	型	説明
アイテム		SignaturePositionResponse	追加の応答固有フィールドを含む署名位置データ。 cardStyle、pageWidth、pageHeight フィールドは省略可能であり、すべての API 応答に存在しない場合があります。

SignaturePositionResponse

名前	パス	型	説明
ページ	page	integer	ページ番号 (0 から始まる)。
x	x	number	署名の左上位置の x 座標
y	y	number	署名の左上位置の y 座標
width	width	number	署名の幅。
height	height	number	署名の高さ。
cardStyle	cardStyle	string	署名カードのビジュアルスタイル。このフィールドは省略可能であり、すべての応答で返されるわけではありません。
pageWidth	pageWidth	number	ページの幅 (ピクセル単位)。このフィールドは省略可能であり、すべての応答で返されるわけではありません。
pageHeight	pageHeight	number	ページの高さ (ピクセル単位)。このフィールドは省略可能であり、すべての応答で返されるわけではありません。

DocumentStatusForFlow

名前	パス	型	説明
id	id	string
名前	name	string
状態	state	string	ドキュメントの現在の状態。使用できる値は、下書き、保留中、拒否済み、完了、添付ファイル、manuallyPending、manuallyCompleted です。
createdAt	createdAt	date
updatedAt	updatedAt	date
allSignersSigned	allSignersSigned	boolean
allMembersSigned	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean