Foxit eSign (プレビュー)

Foxit eSignは、オンラインでドキュメントを送信、署名、管理できる電子署名ソリューションで、印刷、スキャン、郵送が不要です。 ドキュメントをアップロードし、署名フィールドを定義し、電子署名を迅速かつ法的にバインドするために受信者に送信します。

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

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべてのPower Automateリージョン:
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - 中国リージョンAzure
     - 米国国防総省 (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)
お問い合わせ
名前 Foxit eSign のサポート
URL https://www.foxit.com
Email api@foxit.com
コネクタ メタデータ
Publisher Foxit Software Inc.
Web サイト https://www.foxit.com/esign-pdf/
プライバシー ポリシー https://www.foxit.com/company/privacy-policy.html
カテゴリ 生産性;コンテンツとファイル

Foxit eSign

Foxit eSignは、企業が法的拘束力のあるドキュメントをオンラインで送信、署名、管理できるエンタープライズレベルの電子署名ソリューションであり、印刷、スキャン、または郵送の必要性を排除します。 ドキュメントをアップロードし、署名フィールドを定義し、受信者に送信して、高速で安全な電子署名を行います。 Foxit eSign は、ESIGN や UETA を含む主要な電子署名法に完全に準拠しており、暗号化を使用して転送中および保存中のドキュメントを保護し、承認された署名者のみがドキュメントにアクセスして署名できるように多要素認証をサポートしています。

Microsoft Power Automate用 Foxit eSign コネクタを使用すると、エンベロープの作成や署名の送信、状態の追跡、完了したドキュメントのダウンロード、テンプレートの管理、エンベロープ イベント発生時のダウンストリーム アクションのトリガーなど、ドキュメント署名のワークフロー全体を自動化できます。

Publisher: Foxit Corporation

Prerequisites

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

  • カスタム コネクタまたは Premium コネクタ アクセスを使用したMicrosoft Power AppsまたはPower Automateプラン
  • Foxit eSign アカウント - ここで作成します
  • Foxit eSign アカウントで有効になっている API アクセス (以下の資格情報の取得を参照)

資格情報の取得

  1. まだお持ちでない場合は、Foxit eSign アカウントを作成します。
  2. Foxit Sales チームに連絡して、アカウントで API アクセスを有効にするよう要求してください。 承認されると、アカウントで API アクセスがアクティブ化されます。
  3. Power Automateで、コネクタの一覧で Foxit eSign を検索し、[接続の作成] を選択します。
  4. Foxit eSign サインイン ページにリダイレクトされます。 Foxit eSign 資格情報を使用してサインインし、接続を承認します。
  5. 承認されると、フローで接続を使用する準備が整います。

はじめに

接続を作成したら、Foxit eSign コネクタを使用してフローの構築を開始できます。

  • トリガーを使用して、エンベロープ イベントが発生したときに (たとえば、すべての関係者が署名した場合など)、フローを自動的に開始します。
  • アクションを使用して、封筒の作成、署名のリマインダーの送信、完成したドキュメントのダウンロード、テンプレートの管理などを行います。
  • 複数のアクションを連結します。たとえば、テンプレートからエンベロープを作成し、完全に実行されたトリガーを待ってから、署名されたドキュメントをダウンロードしてSharePointに格納します。

サポートされているトリガー

Trigger Description
封筒が送信されたとき 封筒が受信者に送信されたときに起動します。 Webhook レベルが アカウントに設定されている必要があります。
封筒を表示する場合 受信者が開いて封筒を表示すると起動します。
封筒が署名されている場合 受信者が封筒に署名すると発生します。
封筒が取り消されたとき 受信者または送信者が封筒をキャンセルすると発生します。
エンベロープが完全に実行されたとき すべての受信者が署名し、封筒が完全に完了すると発生します。
封筒が削除されたとき エンベロープが削除されたときに起動します。

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

封筒

Action Description
URL からエンベロープを作成する パブリックにアクセスできる PDF URL を使用してエンベロープを作成して送信します。
Base64 からエンベロープを作成する Base64 でエンコードされた PDF ドキュメントを使用して封筒を作成して送信します。
テンプレートから封筒を作成する 既存の Foxit eSign テンプレートからエンベロープを作成して送信します。
封筒の詳細を取得する 封筒の完全な詳細と現在の状態を取得します。
エンベロープ ID を取得する フィルター条件に基づいてエンベロープ ID の一覧を取得します。
署名の通知を送信する 封筒の保留中の署名者にリマインダー通知を送信します。
封筒ファイルのダウンロード 署名されたすべてのドキュメントを zip ファイルとして封筒にダウンロードします。
単一ドキュメント PDF のダウンロード 封筒から 1 つのドキュメントを PDF としてダウンロードします。
封筒をごみ箱に移動する 1 つ以上の封筒をごみ箱に移動します。
封筒のキャンセル 封筒をキャンセルし、受信者に通知します。
封筒を削除する 1 つ以上の封筒を完全に削除します。
エンベロープ アクティビティ履歴を取得する エンベロープの完全なアクティビティ ログを取得します。
削除された封筒の履歴を取得する アカウント内の削除された封筒の履歴を取得します。

Templates

Action Description
URL からテンプレートを作成する パブリックにアクセスできる PDF URL を使用して、再利用可能な署名テンプレートを作成します。
Base64 からテンプレートを作成する Base64 でエンコードされた PDF ドキュメントを使用して、再利用可能な署名テンプレートを作成します。
テンプレートの詳細を取得する フィールド定義を含む特定のテンプレートの完全な詳細を取得します。
テンプレート ID でテンプレートを取得する 1 つ以上のテンプレートの詳細を ID で取得します。
すべてのテンプレートの一覧を取得する アカウントで使用可能なすべてのテンプレートを取得します。

Webhooks

Action Description
すべての Webhook チャネルを一覧表示する アカウントで構成されているすべての Webhook チャネルの一覧を返します。
Webhook チャネルの詳細を取得する 特定の Webhook チャネルの詳細を取得します。

電子メール グループ

Action Description
電子メール グループを作成する 封筒の受信者として使用する新しい電子メール グループを作成します。
電子メール グループの詳細を取得する 電子メール グループの詳細とメンバーを取得します。

報告書

Action Description
レポートのダウンロード アカウント アクティビティ レポートをMicrosoft Excel形式でダウンロードします。

既知の問題と制限事項

  • レート制限: Foxit eSign API では、 アカウントあたり 5 分あたり最大 4,000 要求が許可されます。 この制限を超える要求は、 429 Too Many Requests 応答を受け取ります。 これを適切に処理するには、フローに指数バックオフを使用して再試行ロジックを実装することをお勧めします。

  • ファイル サイズの制限: ドキュメントあたりの最大ファイル サイズは 25 MB です。 この制限は、封筒の合計サイズではなく、個々のファイルに適用されます。

  • Webhook の自動登録解除: Foxit eSign webhook 削除 API (DELETE ではなく POST メソッドを使用) の制限により、トリガーベースのフローが削除または変更されたときに、Power Automateは Webhook チャネル サブスクリプションを自動的にクリーンアップできません。 [ List All Webhook Channels]\(すべての Webhook チャネルの一覧表示 \) アクションを使用してアクティブなチャネルを識別し、Foxit eSign ポータルを使用して、フローの使用を停止するときにサブスクリプションを削除します。

  • エンベロープが送信されたとき — アカウント レベルのみ: "封筒が送信されたとき" トリガーは、Webhook レベルが Account に設定されている場合にのみ発生します。 API アプリ レベルで作成されたエンベロープには起動しません。 このトリガーを構成するときは、必ず [アカウント レベル] を選択してください。

  • リージョンの可用性: コネクタは、北米 (NA1) と EU リージョン アカウントの両方で使用できます。 接続を構成するときに、適切なサーバー リージョンを選択します。 間違ったリージョンに接続すると、認証エラーが発生します。

  • Base64 ドキュメント サイズ: Base64 からのエンベロープの作成アクションまたは Base64 からのテンプレートの作成アクションを使用する場合、Base64 でエンコードされた文字列は、25 MB 以下のソース ファイルに対応している必要があります。

Support

開発者サポートについては、 devsupport@foxitsoftware.comの Foxit eSign チームにお問い合わせください。

サポート ケースを送信するには、 https://kb.foxit.com/s/submit-a-caseにアクセスしてください。

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

Base64 からエンベロープを作成する

Base64 でエンコードされた PDF ドキュメントを使用して封筒を作成して送信します。

Base64 からテンプレートを作成する

Base64 でエンコードされた PDF 文字列を使用して新しいテンプレートを作成します。 これは、PDF ファイルがフローで Base64 文字列として既に使用できる場合に使用します (たとえば、SharePoint ファイルやOneDriveドキュメントから)。

URL からエンベロープを作成する

パブリックにアクセスできる PDF URL を使用して封筒を作成して送信します。 署名プロセスを開始するには、ドキュメントの URL と受信者の詳細を指定します。

URL からテンプレートを作成する

パブリックにアクセスできる PDF URL を使用して新しいテンプレートを作成します。

Webhook チャネルの詳細を取得する

特定の Webhook チャネルの詳細を取得します。

Webhook トリガーの登録を解除する

アクティブな Webhook チャネル サブスクリプションをチャネル ID で削除します。 このアクションを使用して、不要になった Webhook サブスクリプションをクリーンアップします。

すべての Webhook チャネルを一覧表示する

アカウントで構成されているすべての Webhook チャネルの一覧を返します。

すべてのテンプレートの一覧を取得する

アカウントで使用可能なすべてのテンプレートの一覧を返します。

エンベロープ ID を取得する

状態でフィルター処理された封筒 ID の一覧を返します。 これを使用して、特定の状態の封筒を検索します。

エンベロープ アクティビティ履歴を取得する

受信者と送信者が実行したすべてのアクションを示す、エンベロープの完全なアクティビティ ログを取得します。

テンプレート ID でテンプレートを取得する

1 つ以上のテンプレートの詳細を ID で取得します。

テンプレートから封筒を作成する

既存のテンプレートを使用して封筒を作成して送信します。 受信者の詳細はカスタマイズできます。

テンプレートの詳細を取得する

フィールドや受信者など、特定のテンプレートの完全な詳細を取得します。

レポートのダウンロード

エンベロープ アクティビティ レポートをMicrosoft Excel ファイルとしてダウンロードします。 フィルターを使用して、状態、日付範囲、封筒名、作成者、または署名者によって結果を絞り込みます。

削除された封筒の履歴を取得する

削除またはごみ箱に移動された封筒の履歴を取得します。

単一ドキュメント PDF のダウンロード

封筒から 1 つのドキュメントを PDF ファイルとしてダウンロードします。

封筒のキャンセル

送信された封筒をキャンセルします。 受信者はドキュメントに署名できなくなります。

封筒の詳細を取得する

封筒の状態、受信者、ドキュメントなど、封筒の完全な詳細を取得します。

封筒をごみ箱に移動する

1 つ以上の封筒をごみ箱に移動します。 ごみ箱内の封筒は完全には削除されません。

封筒を削除する

1 つ以上の封筒を完全に削除します。

封筒ファイルのダウンロード

封筒から完成したドキュメントをファイルとしてダウンロードします。

署名の通知を送信する

封筒の保留中の受信者にリマインダー通知を送信し、署名を完了するように求めます。

電子メール グループの詳細を取得する

既存の電子メール グループの詳細を取得します。

電子メール グループを作成する

一度に複数の受信者に封筒を送信するために使用できる新しい電子メール グループを作成します。

Base64 からエンベロープを作成する

Base64 でエンコードされた PDF ドキュメントを使用して封筒を作成して送信します。

パラメーター

名前 キー 必須 説明
封筒名
folderName True string

この封筒の名前。

入力の種類
inputType string

ドキュメント ソースの入力の種類。 このアクションの base64 に修正されました。

Base64 ファイル文字列
base64FileString True array of string

送信する Base64 でエンコードされた PDF ドキュメントの配列。

ファイル名
fileNames True array of string

Base64 ファイル文字列配列と同じ順序で、各ドキュメントの表示名の配列。

名前
firstName True string

受信者の名。

lastName True string

受信者の姓。

Emailアドレス
emailId True string

受信者のメール アドレス。

アクセス許可
permission True string
順番
sequence True integer

このフィールドを使用して、受信者のリスト内の受信者にシーケンス番号を割り当てます。 1、2、3、4 など、1 から始まる各パーティに一意のシーケンス番号を使用します。署名ワークフローに 1 人のユーザーが複数回表示される場合は、受信者が繰り返されるたびに異なるシーケンスを割り当ててください。

signerAuthLevels
signerAuthLevel string

署名者が検証のために利用する認証のレベル

プレースホルダー
isPlaceholder boolean

このフィールドを使用して、パーティがプレースホルダーであることを開始します。 注: 1。 firstName、lastName、emailId パラメーターの値は、このパーティの空白にする必要があります。 2. プレースホルダーを追加するには、1 人の受信者を 'PARTY_ASSIGNER' アクセス許可で再実行する必要があります。

受信者ロール
partyRole string

このフィールドを使用して、プレースホルダーのロールを割り当てます。

名前の変更を許可する
allowNameChange string

値には true または false を指定できます。署名プロセスを完了する前に、署名者が姓と名を更新できるようにするには、このパラメーターを使用します。

ワークフロー シーケンス
workflowSequence integer

この受信者にワークフロー シーケンス番号を割り当てます。 サインイン シーケンスが有効になっている場合、受信者は昇順で署名の招待を受け取ります。

ホスト電子メール ID
hostEmailId string

In-Person 管理者の電子メール アドレス。

アクセス コード
userDefinedAccessCode string

認証用に "signerAuthLevel" 値が "ユーザー定義アクセス コード" として設定されている場合、パラメーターには Access Code が含まれます。 注: 1。 コードでは大文字と小文字は区別されません。 2. システムはこのコードを送信しないため、署名者と直接このコードを共有する必要があります。 3. アクセス コードには、アルファベット、数字、および次の特殊文字を含めることができます: @、&{,}、%、(、~、|,!,+、^)。

パーティーは電子メール グループです
partyIsEmailGroup boolean

パーティーを一括で作成する場合は、このパラメーターを使用します。 メモ: このパラメーターが true の場合、このパーティの firstName、lastName、emailId は無視されます。

電子メール グループ ID
emailGroupId integer

一括作成に使用するグループ ID を電子メールで渡します。

シングル 署名者の一括
allowSingleSignerInBulk boolean

このパラメーターを使用して、1 人のユーザーのみが電子メール グループにサインインできるようにします。

ダイヤル コード
dialingCode string

このフィールドを使用して、受信者のリスト内の受信者に携帯電話番号プレフィックスである国のダイヤルイン コードを割り当てます。

携帯電話番号
mobileNumber string

このフィールドを使用して、受信者の一覧で受信者に携帯電話番号を割り当てます。

フィールド
Fields object
今すぐ送信
sendNow boolean

有効にすると、Foxit eSign は直ちに一意の署名リンクを各受信者のメール アドレスに送信します。 封筒を下書きとして保存するには、これを無効にします。

埋め込み署名セッションの作成
createEmbeddedSigningSession True boolean

署名セッション トークンは、受信者に電子メールを送信せずに生成されます。

すべてのパーティの埋め込み署名セッションを作成する
createEmbeddedSigningSessionForAllParties boolean

true に設定すると、エンベロープ内のすべての受信者に対して埋め込み署名 URL が生成されます。

テキスト タグの処理
processTextTags True boolean

値には true または false を指定できます。 このフィールドは、Foxit eSign がテキスト タグのドキュメントを解析して Foxit eSign フィールドに変換する必要があるかどうかを判断するために使用されます。

Acro フィールドの処理
processAcroFields True boolean

このフィールドは、Foxit eSign が AcroFields のドキュメントを解析して Foxit eSign フィールドに変換する必要があるかどうかを判断するために使用されます。

サインイン シーケンス
signInSequence boolean

このフィールドは、受信者が順番に封筒ドキュメントに署名するかどうかを決定するために使用されます。 false の場合、すべての受信者が同時に招待メールを受信します。 true の場合、各受信者は、前の受信者が必要なタスク (ドキュメントへの署名やフィールドの入力など) を完了した後、連続して招待メールを受信します。

In Person Enable
inPersonEnable boolean

このフィールドは、任意のデバイスで数分で簡単に完了できる直接署名プロセスを開始するために使用され、必要に応じて電子メール ベースの署名を回避します。 false の場合、すべての受信者は同時に招待メールを受信します。 true の場合、社内管理者は署名者の署名プロセスを開始するための招待メールを受け取ります。

受信者のパーティを修正する
fixRecipientParties boolean

true の場合、埋め込み送信ビューでは、この要求の一部として既に追加されているエンベロープのパーティを変更できません。

ドキュメントの修正
fixDocuments boolean

true の場合、埋め込み送信では、この要求の一部として既に追加されている封筒のドキュメントを変更できません。

成功 URL の送信
sendSuccessUrl string

埋め込み送信ビューでフォルダーを正常に送信した後に署名者がリダイレクトされるランディング ページの絶対 URL を入力します。

エラー URL の送信
sendErrorUrl string

埋め込み送信ビューでのフォルダーの送信中にエラーが発生した場合に署名者がリダイレクトされるランディング ページの絶対 URL を入力します。

埋め込み送信セッションを作成する
createEmbeddedSendingSession boolean

true に設定すると、埋め込みトークンが生成され、Foxit eSign のドキュメント準備ビューが開きます。

埋め込み署名者の電子メール ID
embeddedSignersEmailIds array of string

埋め込み署名セッションを作成する必要がある受信者の電子メール ID の配列。 パーティの一覧に追加された受信者の電子メール ID。

成功 URL に署名する
signSuccessUrl string

埋め込み署名ビューに正常にサインインした後にリダイレクトされる署名者の絶対 URL を入力します。

辞退 URL に署名する
signDeclineUrl string

埋め込み署名ビューへのサインインを拒否した場合にリダイレクトされる署名者の絶対 URL を入力します。

後で URL に署名する
signLaterUrl string

埋め込み署名ビューで後でサインインすることを選択した場合にリダイレクトされる署名者の絶対 URL を入力します。

エラー URL に署名する
signErrorUrl string

埋め込み署名ビューでドキュメントの署名中にエラーが発生した場合にリダイレクトされる署名者の絶対 URL を入力します。

今すぐ送信と埋め込み署名セッションを許可する
allowSendNowAndEmbeddedSigningSession boolean

true に設定すると、Foxit eSign は一意の署名リンクを各受信者に送信します。 これは、パラメーター sendNow と createEmbeddedSigningSession が true の場合にのみ適用されます。

高度な電子メール検証
allowAdvancedEmailValidation boolean

true に設定されている場合は、パーティーの電子メール アドレスを検証します。

Sign Success Url All Parties
signSuccessUrlAllParties boolean

true に設定すると、署名に成功した後、署名者は signSuccessUrl で指定された URL にリダイレクトされます。 これは、sendNow が true の場合にのみ適用されます。

電子メール テンプレート ID
emailTemplateId integer

電子メール テンプレート ID を渡して、既定の電子メール テンプレート以外の電子メール テンプレートを送信します。

署名者命令 ID
signerInstructionId integer

既定の署名者命令以外の署名者命令を送信する命令 ID を渡します。

確認命令 ID
confirmationInstructionId string

確認指示 ID を渡して、既定の確認手順以外の確認指示を送信します。

テーマの色
themeColor string

CSS 値を入力してテーマの色を設定します。

セッションの有効期限
sessionExpire boolean

埋め込み署名セッションの有効期限を開始するには、true に設定します。

有効期限
expiry integer

sessionExpire が true の場合は必須。 埋め込み署名セッションの有効期限のミリ秒単位の期間を入力します。

依存フィールド名
dependentFieldName True string

親フィールドによって表示が制御されるフィールドの名前。

親フィールド名
parentFieldName True string

依存フィールドの表示を制御する値を持つ親フィールドの名前。 サポートされている親フィールドの種類: textfield、textbox、checkbox、radiobutton、dropdown。

親フィールド値
parentFieldValue True string

依存フィールドが表示されるようにトリガーする親フィールドの値。 チェック ボックスとラジオ ボタン フィールドの場合は、オンまたはオフを使用します。

オプション
options True string

テキスト ベースの親フィールドの追加の一致オプション。 受け入れ可能な値: isblank、allowNull、contains。

Metadata
metadata object

これはキーと値のペアである必要があります。 最大 1,000 個のキー値ペアを使用できます。

送信者の電子メール
senderEmail string

このドキュメント フォルダーを受信者に送信するために使用する、アカウント内の別のユーザーの電子メールを入力します。

[自分の追加] ボタンを非表示にする
hideAddMeButton boolean

true の場合、埋め込み送信セッションの受信者の [自分の追加] ボタンが非表示になります。

[新しい追加] ボタンを非表示にする
hideAddNewButton boolean

true の場合、埋め込み送信セッションの受信者パーティの [新規追加] ボタンが非表示になります。

[グループの追加] ボタンを非表示にする
hideAddGroupButton boolean

true の場合、埋め込み送信セッションの受信者パーティの [グループの追加] ボタンが非表示になります。

受信者のフィールド名を非表示にする
hideFieldNameForRecipients boolean

データ入力フィールドと高度なフィールドの受信者のフィールド名を非表示にします。 (オプション ボタン、チェックボックス、イメージ、ハイパーリンクを除く)。

チェック ボックスの罫線を非表示にする
hideCheckboxBorder boolean

チェック ボックスの罫線は、実行されたドキュメントでは非表示になります。

署名者の選択オプションを非表示にする
hideSignerSelectOption boolean

true の場合、埋め込み送信セッションの受信者の [既存の署名者名/電子メール] 入力ボックスが非表示になります。

署名者アクションを非表示にする
hideSignerActions boolean

true の場合、埋め込み送信セッションの受信者に対する署名者の "編集"、"変更"、"削除" アクションが非表示になります。

送信者名を非表示にする
hideSenderName boolean

true の場合、埋め込み送信セッションの受信者パーティの送信者名が非表示になります。

フォルダー名を非表示にする
hideFolderName boolean

true の場合、両方の埋め込みセッションのナビゲーションでフォルダー名が非表示になります。

ドキュメント名を非表示にする
hideDocumentsName boolean

true の場合、両方の埋め込みセッションでドキュメント名が非表示になります。

署名の拒否を非表示にする
hideDeclineToSign boolean

true の場合、署名者の [署名を辞退する] オプションが非表示になります。

その他のアクションを非表示にする
hideMoreAction boolean

true の場合、送信/署名セッションの [その他のアクション] ボタンが非表示になります。 "今すぐ送信" の場合: true の場合、何も非表示になりません。

送信ボタンを非表示にする
hideSendButton boolean

true の場合、埋め込み送信セッションの [送信] ボタンが非表示になります。

次の必須 Fieldbtn を非表示にする
hideNextRequiredFieldbtn boolean

true に設定すると、署名者を次の必須フィールドに移動するナビゲーション ボタンが非表示になります。

必須の両方の埋め込みセッション
requiredBothEmbeddedSession boolean

true の場合、埋め込みの送信 URL と署名 URL が生成されます。

封筒のパスワード
folderPassword string

このパスワードは、デジタル署名されたドキュメントを開くために署名者/作成者が必要とします。 パラメーターを空白のままにした場合、デジタル署名されたドキュメントを開くためにパスワードは必要ありません。

ステップ バイ ステップを有効にする
enableStepByStep boolean

埋め込み送信セッションでステップ バイ ステップ アクションを有効にする。

[パーティーの追加] オプションを非表示にする
hideAddPartiesOption boolean

true の場合、下書きおよびテンプレート作成モードでパーティオプションを追加するオプションが非表示になります。

セルフ サイン
selfSign boolean

API を使用して埋め込みセルフ サインを有効にします。 このパラメーターは、createEmbeddedSendingSession パラメーターが true の場合にのみ適用されます。

セルフ 署名者の成功 URL
selfSignerSuccessUrl string

Web サイト/アプリケーションのランディング ページの絶対 URL を入力します。この URL は、埋め込み送信ビューでフォルダーを送信した後にユーザーがリダイレクトされます。

返品

名前 パス 説明
ID
folder.folderId integer

新しく作成された封筒の一意の ID。 これを後続のアクションで使用して、このエンベロープを参照します。

名前
folder.folderName string

新しく作成された封筒の名前。

カスタム名
folder.folderCustomName string

封筒のカスタム名。

パスワード
folder.folderPassword string

封筒のアクセス パスワード (設定されている場合)。

作成者 ID
folder.folderAuthorId integer

エンベロープ作成者の一意識別子。

作成者名
folder.folderAuthorFirstName string

封筒作成者の名。

作成者の姓
folder.folderAuthorLastName string

封筒作成者の姓。

作成者の電子メール
folder.folderAuthorEmail string

封筒作成者のメール アドレス。

Creator ロール
folder.folderAuthorRole string

封筒作成者の役割。

会社 ID
folder.folderCompanyId integer

封筒を所有する会社の一意識別子。

作成日
folder.folderCreationDate integer

エンベロープが作成された日付 (Unix タイムスタンプ (ミリ秒)。

送信日
folder.folderSentDate integer

エンベロープが送信された日付 (Unix タイムスタンプ (ミリ秒)。

地位
folder.folderStatus string

封筒の現在の状態。

ユーザー設定フィールド 1
folder.custom_field1 string

封筒の最初のユーザー設定メタデータ フィールド。

ユーザー設定フィールド 2
folder.custom_field2 string

封筒の 2 番目のユーザー設定メタデータ フィールド。

Metadata
folder.metadata string

エンベロープに関連付けられているカスタム メタデータ。

ドキュメント ID
folder.folderDocumentIds array of integer

封筒に含まれるドキュメント ID の一覧。

ドキュメント​
folder.documentsList array of object

封筒内のドキュメントの一覧。

ドキュメント ID
folder.documentsList.documentId integer

ドキュメントの一意識別子。

コントラクト ID
folder.documentsList.contractId integer

コントラクトの一意識別子。

会社 ID
folder.documentsList.companyId integer

会社の一意識別子。

作成者
folder.documentsList.contractCreatedBy integer

コントラクトを作成したユーザーのユーザー ID。

作成日
folder.documentsList.contractCreatedOn string

コントラクトが作成された日時。

コントラクトの種類
folder.documentsList.contractType string

コントラクトの型。

コントラクトの状態
folder.documentsList.contractStatus string

コントラクトの現在の状態。

編集可能
folder.documentsList.editable boolean

アイテムが編集可能かどうかを示します。

バージョン ID
folder.documentsList.contractVersionId integer

コントラクト バージョンの一意識別子。

バージョン名
folder.documentsList.contractVersionName string

コントラクト バージョンの名前。

バージョンの説明
folder.documentsList.contractVersionDesc string

コントラクト バージョンの説明。

作成者のバージョン
folder.documentsList.versionCreatedby integer

このバージョンを作成したユーザーのユーザー ID。

作成日のバージョン
folder.documentsList.versionCreatedOn string

このバージョンが作成された日付と時刻。

バージョン番号
folder.documentsList.contractVersionNumber integer

コントラクトのバージョン番号。

トランザクション ソース
folder.documentsList.contractTransactionSource string

コントラクト トランザクションを開始したソース システム。

受取人
folder.folderRecipientParties array of object

この封筒の受信者の一覧。

受信者 ID
folder.folderRecipientParties.partyId integer

受信者の一意識別子。

受信者 ID
folder.folderRecipientParties.partyDetails.partyId integer

受信者の一意識別子。

名前
folder.folderRecipientParties.partyDetails.firstName string

受信者の名前。

folder.folderRecipientParties.partyDetails.lastName string

受信者の姓。

Emailアドレス
folder.folderRecipientParties.partyDetails.emailId string

受信者のメール アドレス。

プレースホルダー
folder.folderRecipientParties.partyDetails.placeholder boolean

このパーティがプレースホルダーの受信者かどうかを示します。

住所
folder.folderRecipientParties.partyDetails.address string

受信者の物理アドレス。

作成日
folder.folderRecipientParties.partyDetails.dateCreated integer

レコードが作成された日付 (Unix タイムスタンプ (ミリ秒)。

電子メールをオプトアウトする
folder.folderRecipientParties.partyDetails.optOutEmails boolean

受信者が電子メール通知をオプトアウトしたかどうかを示します。

一意の受信者 ID
folder.folderRecipientParties.partyDetails.uniquePartyId string

この受信者の一意のシステム識別子。

認証レベル
folder.folderRecipientParties.partyDetails.authenticationLevel string

この受信者に必要な認証方法。

パスワードの更新日
folder.folderRecipientParties.partyDetails.passwordUpdateDate string

パスワードが最後に更新された日付。

パスワードの更新状態
folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

パスワードが更新されたかどうかを示します。

会社 ID
folder.folderRecipientParties.partyDetails.companyId integer

会社の一意識別子。

ユーザー ロール
folder.folderRecipientParties.partyDetails.userRole string

ユーザーに割り当てられたロール。

部門
folder.folderRecipientParties.partyDetails.department string

ユーザーが属している部署。

Title
folder.folderRecipientParties.partyDetails.title string

ユーザーの役職。

アクティブ
folder.folderRecipientParties.partyDetails.active boolean

ユーザーまたはレコードがアクティブかどうかを示します。

ロケール
folder.folderRecipientParties.partyDetails.requestLocale string

ユーザーのロケール設定。

Dept と共有する
folder.folderRecipientParties.partyDetails.share_among_department boolean

部門全体で封筒を共有するかどうかを示します。

ダイヤル コード
folder.folderRecipientParties.partyDetails.dialingCode string

電話番号の国際ダイヤル コード。

携帯電話番号
folder.folderRecipientParties.partyDetails.mobileNumber string

携帯電話番号。

状態フィルター
folder.folderRecipientParties.partyDetails.docStatusFilter string

ドキュメントの状態のフィルター。

日付フィルター
folder.folderRecipientParties.partyDetails.docDateFilter string

ドキュメントの日付のフィルター。

フィールド アクセスのセキュリティ保護
folder.folderRecipientParties.partyDetails.userSecureFieldAccess boolean

ユーザーがセキュリティで保護されたフィールドにアクセスできるかどうかを示します。

サイドバーを展開する
folder.folderRecipientParties.partyDetails.expandSidebar boolean

サイドバーが既定で展開されているかどうかを示します。

Adv. 電子メールの検証
folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation boolean

電子メールの高度な検証が有効かどうかを示します。

マネージャー ID
folder.folderRecipientParties.partyDetails.managerId string

ユーザーのマネージャーの一意識別子。

ログイン数
folder.folderRecipientParties.partyDetails.loginCount integer

ユーザーがログインした回数。

パスワード リセットの電子メール
folder.folderRecipientParties.partyDetails.sendMailForPasswordReset boolean

パスワード リセット電子メールを送信するかどうかを示します。

部門 ID
folder.folderRecipientParties.partyDetails.departmentId string

部署の一意識別子。

プライマリ企業
folder.folderRecipientParties.partyDetails.userPrimaryCompany integer

ユーザーに関連付けられているプライマリ企業。

デバイスの種類
folder.folderRecipientParties.partyDetails.deviceType string

使用されるデバイスの種類。

デバイス トークン
folder.folderRecipientParties.partyDetails.deviceToken string

デバイスのプッシュ通知トークン。

協力会社の説明
folder.folderRecipientParties.partyDetails.subcontractorDescription string

下請け業者または外部署名者の説明。

協力会社組織
folder.folderRecipientParties.partyDetails.subcontractorOrganization string

下請け業者または外部署名者の組織名。

協力会社の追加日
folder.folderRecipientParties.partyDetails.subcAddedDate integer

下請け業者が追加された日付 (Unix タイムスタンプ (ミリ秒)。

Source
folder.folderRecipientParties.partyDetails.source string

外部署名者が追加されたソース システム。

ダイヤル コード
folder.folderRecipientParties.dialingCode string

電話番号の国際ダイヤル コード。

携帯電話番号
folder.folderRecipientParties.mobileNumber string

携帯電話番号。

署名の種類
folder.folderRecipientParties.signerSignatureType string

署名者が使用する署名の種類。

Permissions
folder.folderRecipientParties.contractPermissions string

コントラクトに対してこのパーティに付与されたアクセス許可。

署名順序
folder.folderRecipientParties.partySequence integer

この受信者の署名順序シーケンス番号。

ワークフロー シーケンス
folder.folderRecipientParties.workflowSignSequence integer

ワークフロー署名シーケンス番号。

封筒 ID
folder.folderRecipientParties.envelopeId integer

封筒の一意識別子。

受信者の会社 ID
folder.folderRecipientParties.partyCompanyId integer

この受信者に関連付けられている会社の一意識別子。

共有モード
folder.folderRecipientParties.sharingMode string

このエンベロープの共有モード。

受信者アクセス URL
folder.folderRecipientParties.folderAccessURL string

受信者が封筒にアクセスして署名するために使用できる URL。

セキュリティ モード
folder.folderRecipientParties.securityMode string

このエンベロープに適用されるセキュリティ モード。

コメント
folder.folderRecipientParties.extraComments string

封筒に含まれる追加のコメント。

名前の変更を許可する
folder.folderRecipientParties.allowNameChange boolean

受信者が自分の名前を更新できるかどうかを示します。

更新された名前
folder.folderRecipientParties.signerNameUpdated boolean

署名者が自分の名前を更新したかどうかを示します。

署名者の認証レベル
folder.folderRecipientParties.signerAuthenticationLevel string

署名者に必要な認証レベル。

アクセス コード
folder.folderRecipientParties.userDefinedAccessCode string

署名者に対して定義されたカスタム アクセス コード。

署名 ID
folder.folderRecipientParties.signatureId string

署名の一意識別子。

受信者ロール
folder.folderRecipientParties.partyRole string

署名ワークフローでこの受信者に割り当てられたロール。

会社フィールド
folder.folderRecipientParties.companyFieldValue string

署名の会社名フィールドの値。

タイトル フィールド
folder.folderRecipientParties.titleFieldValue string

署名のタイトル フィールドの値。

署名の理由
folder.folderRecipientParties.reasonSigning string

受信者がドキュメントに署名する理由。

支払フィールドの追加
folder.folderRecipientParties.payFieldAdded boolean

支払フィールドが追加されたかどうかを示します。

受取 人
folder.folderRecipientParties.payee boolean

この受信者が支払い先かどうかを示します。

定期支払い
folder.folderRecipientParties.recurringFieldExist boolean

定期的な支払いフィールドが存在するかどうかを示します。

印刷と署名の完了
folder.folderRecipientParties.printAndSignCompleted boolean

印刷と署名のプロセスが完了したかどうかを示します。

有料
folder.folderRecipientParties.paid boolean

支払いが完了したかどうかを示します。

省略可能な署名者許可
folder.folderRecipientParties.allowOptionalSigner boolean

この受信者が省略可能な署名者であるかどうかを示します。

省略可能な署名者
folder.folderRecipientParties.optionalSigners array of integer

この封筒のオプションの署名者パーティー ID の一覧。

作成者の署名 URL
folder.folderAccessURLForAuthor string

送信者がエンベロープへのアクセスに使用できる URL。

下書きアクセス URL
folder.draftFolderAccessURL string

封筒の下書きバージョンへのアクセスに使用される URL。

ボードルーム署名
folder.boardRoomSign boolean

ボード ルーム署名モードが有効かどうかを示します。

ロゴを含める
folder.includeLogo boolean

会社のロゴが電子メールに含まれているかどうかを示します。

ボタンの背景色
folder.email_btnBgColor string

メール ボタンの背景色。

ボタンテキストの色
folder.email_btnTxtColor string

電子メール ボタンのテキストの色。

電子メール のロゴ
folder.emailTemplateLogo string

電子メール テンプレートで使用されるロゴ URL。

電子メール テンプレート ID
folder.emailTemplateId integer

電子メール テンプレートの一意識別子。

電子メール ヘッダー
folder.emailHeader string

通知メールで使用されるヘッダー テキスト。

電子メール フッター
folder.emailFooter string

通知メールで使用されるフッター テキスト。

スケジュールされた消去
folder.purgeFlag boolean

エンベロープの消去がスケジュールされているかどうかを示します。

消去の開始日
folder.purgeStartDate string

消去の開始をスケジュールする日付。

終了日を消去する
folder.purgeEndDate string

消去が完了するようにスケジュールされている日付。

一括送信 ID
folder.bulkId integer

一括送信操作の一意識別子。

署名順序を適用する
folder.enforceSignWorkflow boolean

受信者が定義済みのシーケンスにサインインする必要があるかどうかを示します。

現在のステップ
folder.currentWorkflowStep integer

署名ワークフローの現在のステップ。

トランザクション ソース
folder.transactionSource string

このトランザクションを開始したソース システム。

編集可能
folder.editable boolean

アイテムが編集可能かどうかを示します。

In-Person 署名
folder.inPersonSignable boolean

封筒を個人でサインインできるかどうかを示します。

アラームをオーバーライドする
folder.overrideAccountReminders boolean

アカウント レベルのアラーム設定をオーバーライドするかどうかを示します。

委任のオーバーライド
folder.overrideAccountRecipientDelegation boolean

アカウント レベルの委任設定がオーバーライドされるかどうかを示します。

委任を許可する
folder.allowRecipientsToDelegate boolean

受信者が署名の委任を許可されているかどうかを示します。

ID
folder.envelopeId integer

封筒の一意識別子。

名前
folder.envelopeName string

封筒の名前。

発信元 ID
folder.envelopeOriginatorId integer

エンベロープを作成したユーザーの一意識別子。

会社 ID
folder.envelopeCompanyId integer

封筒を所有する会社の一意識別子。

Date
folder.envelopeDate integer

エンベロープが作成された日付 (Unix タイムスタンプ (ミリ秒)。

共有日
folder.envelopeSharedDate integer

エンベロープが共有された日付 (Unix タイムスタンプ (ミリ秒)。

地位
folder.envelopeStatus string

封筒の現在の状態。

コントラクト ID
folder.envelopeContractIds array of integer

このエンベロープに関連付けられているコントラクト ID の一覧。

受信者のアクセス許可
folder.envelopePartyPermissions array of object

この封筒の受信者のアクセス許可の一覧。

受信者 ID
folder.envelopePartyPermissions.partyId integer

受信者の一意識別子。

受信者 ID
folder.envelopePartyPermissions.partyDetails.partyId integer

受信者の一意識別子。

名前
folder.envelopePartyPermissions.partyDetails.firstName string

受信者の名前。

folder.envelopePartyPermissions.partyDetails.lastName string

受信者の姓。

Emailアドレス
folder.envelopePartyPermissions.partyDetails.emailId string

受信者のメール アドレス。

プレースホルダー
folder.envelopePartyPermissions.partyDetails.placeholder boolean

このパーティがプレースホルダーの受信者かどうかを示します。

住所
folder.envelopePartyPermissions.partyDetails.address string

受信者の物理アドレス。

作成日
folder.envelopePartyPermissions.partyDetails.dateCreated integer

レコードが作成された日付 (Unix タイムスタンプ (ミリ秒)。

電子メールをオプトアウトする
folder.envelopePartyPermissions.partyDetails.optOutEmails boolean

受信者が電子メール通知をオプトアウトしたかどうかを示します。

一意の受信者 ID
folder.envelopePartyPermissions.partyDetails.uniquePartyId string

この受信者の一意のシステム識別子。

認証レベル
folder.envelopePartyPermissions.partyDetails.authenticationLevel string

この受信者に必要な認証方法。

パスワードの更新日
folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string

パスワードが最後に更新された日付。

パスワードの更新状態
folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean

パスワードが更新されたかどうかを示します。

会社 ID
folder.envelopePartyPermissions.partyDetails.companyId integer

会社の一意識別子。

ユーザー ロール
folder.envelopePartyPermissions.partyDetails.userRole string

ユーザーに割り当てられたロール。

部門
folder.envelopePartyPermissions.partyDetails.department string

ユーザーが属している部署。

Title
folder.envelopePartyPermissions.partyDetails.title string

ユーザーの役職。

アクティブ
folder.envelopePartyPermissions.partyDetails.active boolean

ユーザーまたはレコードがアクティブかどうかを示します。

ロケール
folder.envelopePartyPermissions.partyDetails.requestLocale string

ユーザーのロケール設定。

Dept と共有する
folder.envelopePartyPermissions.partyDetails.share_among_department boolean

部門全体で封筒を共有するかどうかを示します。

ダイヤル コード
folder.envelopePartyPermissions.partyDetails.dialingCode string

電話番号の国際ダイヤル コード。

携帯電話番号
folder.envelopePartyPermissions.partyDetails.mobileNumber string

携帯電話番号。

状態フィルター
folder.envelopePartyPermissions.partyDetails.docStatusFilter string

ドキュメントの状態のフィルター。

日付フィルター
folder.envelopePartyPermissions.partyDetails.docDateFilter string

ドキュメントの日付のフィルター。

フィールド アクセスのセキュリティ保護
folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess boolean

ユーザーがセキュリティで保護されたフィールドにアクセスできるかどうかを示します。

サイドバーを展開する
folder.envelopePartyPermissions.partyDetails.expandSidebar boolean

サイドバーが既定で展開されているかどうかを示します。

Adv. 電子メールの検証
folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation boolean

電子メールの高度な検証が有効かどうかを示します。

マネージャー ID
folder.envelopePartyPermissions.partyDetails.managerId string

ユーザーのマネージャーの一意識別子。

ログイン数
folder.envelopePartyPermissions.partyDetails.loginCount integer

ユーザーがログインした回数。

パスワード リセットの電子メール
folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset boolean

パスワード リセット電子メールを送信するかどうかを示します。

部門 ID
folder.envelopePartyPermissions.partyDetails.departmentId string

部署の一意識別子。

プライマリ企業
folder.envelopePartyPermissions.partyDetails.userPrimaryCompany integer

ユーザーに関連付けられているプライマリ企業。

デバイスの種類
folder.envelopePartyPermissions.partyDetails.deviceType string

使用されるデバイスの種類。

デバイス トークン
folder.envelopePartyPermissions.partyDetails.deviceToken string

デバイスのプッシュ通知トークン。

協力会社の説明
folder.envelopePartyPermissions.partyDetails.subcontractorDescription string

下請け業者または外部署名者の説明。

協力会社組織
folder.envelopePartyPermissions.partyDetails.subcontractorOrganization string

下請け業者または外部署名者の組織名。

協力会社の追加日
folder.envelopePartyPermissions.partyDetails.subcAddedDate integer

下請け業者が追加された日付 (Unix タイムスタンプ (ミリ秒)。

Source
folder.envelopePartyPermissions.partyDetails.source string

外部署名者が追加されたソース システム。

ダイヤル コード
folder.envelopePartyPermissions.dialingCode string

電話番号の国際ダイヤル コード。

携帯電話番号
folder.envelopePartyPermissions.mobileNumber string

携帯電話番号。

署名の種類
folder.envelopePartyPermissions.signerSignatureType string

署名者が使用する署名の種類。

Permissions
folder.envelopePartyPermissions.contractPermissions string

コントラクトに対してこのパーティに付与されたアクセス許可。

署名順序
folder.envelopePartyPermissions.partySequence integer

この受信者の署名順序シーケンス番号。

ワークフロー シーケンス
folder.envelopePartyPermissions.workflowSignSequence integer

ワークフロー署名シーケンス番号。

封筒 ID
folder.envelopePartyPermissions.envelopeId integer

封筒の一意識別子。

受信者の会社 ID
folder.envelopePartyPermissions.partyCompanyId integer

この受信者に関連付けられている会社の一意識別子。

共有モード
folder.envelopePartyPermissions.sharingMode string

このエンベロープの共有モード。

受信者アクセス URL
folder.envelopePartyPermissions.folderAccessURL string

受信者が封筒にアクセスして署名するために使用できる URL。

セキュリティ モード
folder.envelopePartyPermissions.securityMode string

このエンベロープに適用されるセキュリティ モード。

コメント
folder.envelopePartyPermissions.extraComments string

封筒に含まれる追加のコメント。

名前の変更を許可する
folder.envelopePartyPermissions.allowNameChange boolean

受信者が自分の名前を更新できるかどうかを示します。

更新された名前
folder.envelopePartyPermissions.signerNameUpdated boolean

署名者が自分の名前を更新したかどうかを示します。

署名者の認証レベル
folder.envelopePartyPermissions.signerAuthenticationLevel string

署名者に必要な認証レベル。

アクセス コード
folder.envelopePartyPermissions.userDefinedAccessCode string

署名者に対して定義されたカスタム アクセス コード。

署名 ID
folder.envelopePartyPermissions.signatureId string

署名の一意識別子。

受信者ロール
folder.envelopePartyPermissions.partyRole string

署名ワークフローでこの受信者に割り当てられたロール。

会社フィールド
folder.envelopePartyPermissions.companyFieldValue string

署名の会社名フィールドの値。

タイトル フィールド
folder.envelopePartyPermissions.titleFieldValue string

署名のタイトル フィールドの値。

署名の理由
folder.envelopePartyPermissions.reasonSigning string

受信者がドキュメントに署名する理由。

支払フィールドの追加
folder.envelopePartyPermissions.payFieldAdded boolean

支払フィールドが追加されたかどうかを示します。

受取 人
folder.envelopePartyPermissions.payee boolean

この受信者が支払い先かどうかを示します。

定期支払い
folder.envelopePartyPermissions.recurringFieldExist boolean

定期的な支払いフィールドが存在するかどうかを示します。

印刷と署名の完了
folder.envelopePartyPermissions.printAndSignCompleted boolean

印刷と署名のプロセスが完了したかどうかを示します。

有料
folder.envelopePartyPermissions.paid boolean

支払いが完了したかどうかを示します。

認証レベル
folder.envelopeAuthenticationLevel string

エンベロープに必要な認証レベル。

シングル 署名者の一括
folder.allowSingleSignerInBulk boolean

シングル 署名者が一括送信モードで許可されるかどうかを示します。

File-Based の名前付け
folder.folderNameBasedOnFileNaming boolean

フォルダー名がファイル名に基づいているかどうかを示します。

ドキュメント File-Based 名
folder.documentNameBasedOnFileNaming boolean

ドキュメント名がファイル名に基づいているかどうかを示します。

証明書 File-Based 名
folder.certificateNameBasedOnFileNaming boolean

証明書名がファイル名に基づいているかどうかを示します。

Pre-Exec ファイルの名前付け
folder.enableFileNamingBeforeExecution boolean

ドキュメントの実行前にファイルの名前付けを有効にするかどうかを示します。

追加された支払い先
folder.payeeAddedd boolean

支払い先が追加されたかどうかを示します。

Self-Signing 有効
folder.selfSignerEnabled boolean

セルフ署名モードが有効かどうかを示します。

[公証人が有効]
folder.notaryEnabled boolean

公証人署名が有効かどうかを示します。

制限付き可視性
folder.limitedVisibilityFlag boolean

このエンベロープの表示が制限されているかどうかを示します。

署名後の可視性
folder.postSigningVisibility boolean

署名後の可視性が有効かどうかを示します。

Wet Signature
folder.wetSignatureEnabled boolean

ウェット署名が有効かどうかを示します。

マージが有効
folder.mergeEnabled boolean

ドキュメントのマージが有効かどうかを示します。

埋め込み署名セッション
embeddedSigningSessions array of object

埋め込み署名セッションの一覧 。受信者ごとに 1 つ。 createEmbeddedSigningSession が true の場合にのみ存在します。

署名者の電子メール
embeddedSigningSessions.emailIdOfSigner string

この埋め込み署名セッションの受信者の電子メール アドレス。

署名トークン
embeddedSigningSessions.embeddedToken string

この受信者の埋め込み署名セッションの一意のトークン。

署名セッション URL
embeddedSigningSessions.embeddedSessionURL string

この受信者がドキュメントに署名するために開くか埋め込む URL。

埋め込み送信トークン
embeddedToken string

埋め込み送信セッションのトークン。 createEmbeddedSendingSession が true の場合にのみ存在します。

セッション URL の送信
embeddedSessionURL string

封筒作成者が封筒を準備して送信するために開くか埋め込む URL。 createEmbeddedSendingSession が true の場合にのみ存在します。

Result
result string

操作の結果。

Message
message string

操作の結果を説明するメッセージ。

Base64 からテンプレートを作成する

Base64 でエンコードされた PDF 文字列を使用して新しいテンプレートを作成します。 これは、PDF ファイルがフローで Base64 文字列として既に使用できる場合に使用します (たとえば、SharePoint ファイルやOneDriveドキュメントから)。

パラメーター

名前 キー 必須 説明
テンプレート名
templateName True string

テンプレートの名前。 .pdf 拡張子で終わる必要があります (例: onboarding.pdf)。

Base64 ファイル文字列
base64FileString True string

テンプレート作成用の PDF の BASE64 文字列。 テンプレートを作成するときは、パブリックにアクセスできる必要があります。

入力の種類
inputType True string

ドキュメントの入力メソッド。 このアクションでは、常に 'base64' に設定します。

テキスト タグの処理
processTextTags True boolean

有効にすると、Foxit eSign はドキュメントでテキスト タグをスキャンし、自動的に署名フィールドに変換します。

Acro フィールドの処理
processAcroFields True boolean

有効にすると、Foxit eSign はドキュメントで AcroFields をスキャンし、自動的に署名フィールドに変換します。

[すべて共有]
shareAll True boolean

このテンプレートをアカウント内のすべてのユーザーと共有します。

パーティの数
numberOfParties True integer

このテンプレートの受信者の数。 20 未満にする必要があります。

テーマの色
themeColor string

埋め込みテンプレート セッションのテーマをカスタマイズするための CSS カラー値 (例: #42caf4)。

作成者Email
authorEmail string

このテンプレートの作成者として設定するアカウント内の別のユーザーのメール アドレス。

埋め込みテンプレート セッションの作成
createEmbeddedTemplateSession boolean

true に設定すると、埋め込みテンプレート セッションが作成され、Foxit eSign テンプレート エディターを直接開き、フィールドをテンプレートにドラッグ アンド ドロップできます。

リダイレクト URL
redirectURL string

埋め込みテンプレート セッションの作成が true の場合、埋め込みテンプレート エディターで [保存して閉じる] をクリックした後にユーザーをリダイレクトする URL。

送信テンプレートを非表示にする
hideSendTemplate boolean

true の場合、埋め込みテンプレート エディターでは [送信] ボタンが非表示になります。

受信者のパーティを修正する
fixRecipientParties boolean

true の場合、埋め込みテンプレート エディターで既に追加されている受信者を変更することはできません。

フィールド
Fields object
アクセス許可
permission True string
順番
sequence True integer

1 から始まる、このパーティーの一意のシーケンス番号。 サインイン シーケンスが有効な場合の署名順序を定義します。

受信者ロール
partyRole True string

テンプレートでこのパーティに割り当てられたロール。

その他のアクションを非表示にする
hideMoreAction boolean

true の場合、埋め込みテンプレート セッションでは [その他のアクション] ボタンが非表示になります。

[すべて共有] を非表示にする
hideShareWithAll boolean

true の場合、埋め込みテンプレート セッションでは [すべて共有] オプションが非表示になります。

パーティーの追加を非表示にする
hideAddParty boolean

true の場合、すべての追加パーティ オプションは埋め込みテンプレート セッションで非表示になります。

[非表示] ボタン
hideMeButton boolean

true の場合、埋め込みテンプレート セッションでは受信者パーティの [自分] ボタンが非表示になります。

[他のユーザーを非表示にする] ボタン
hideOthersButton boolean

true の場合、埋め込みテンプレート セッションでは受信者パーティの [その他] ボタンが非表示になります。

受信者のフィールド名を非表示にする
hideFieldNameForRecipients boolean

true の場合、データ入力フィールドと詳細フィールドの受信者にはフィールド名が非表示になります。

チェック ボックスの罫線を非表示にする
hideCheckboxBorder boolean

true の場合、実行されるドキュメントではチェック ボックスの罫線が非表示になります。

返品

名前 パス 説明
Result
result string

操作が成功したかどうかを示します (例: 'success')。

Message
message string

操作の結果の説明。

ID
template.templateId integer

作成されたテンプレートの一意の ID。 これを使用して、このテンプレートから封筒を作成します。

名前
template.templateName string

テンプレートの名前。

Description
template.templateDesc string

テンプレートの説明。

タイプ
template.templateType string

テンプレートの種類。

[作成日付]
template.templateCreationDate string

テンプレートが作成された日付。

最終更新日
template.templateLastUpdateDate string

テンプレートが最後に更新された日付。

編集可能
template.editable boolean

テンプレートを編集できるかどうかを示します。

パーティの数
template.numberOfParties integer

テンプレートで定義されている受信者の数。

合計ページ数
template.totalPages integer

テンプレート ドキュメント内のページの合計数。

会社 ID
template.companyId integer

このテンプレートが属する会社の ID。

すべて共有
template.shareAll boolean

このテンプレートがアカウント内のすべてのユーザーと共有されているかどうかを示します。

パーティのアクセス許可
template.templatePartyPermissions array of object

このテンプレートで定義されている受信者ロールとそのアクセス許可の一覧。

関係者 ID
template.templatePartyPermissions.template_party_id integer

このテンプレート パーティ エントリの一意の ID。

ID
template.templatePartyPermissions.templateId integer

このパーティが属するテンプレートの ID。

Permissions
template.templatePartyPermissions.templatePermissions string

このパーティの署名アクセス許可 (例: FILL_FIELDS_AND_SIGN)。

署名順序
template.templatePartyPermissions.partySequence integer

このパーティの署名注文の位置。

パーティー ロール
template.templatePartyPermissions.templatePartyRole string

テンプレートでこのパーティに割り当てられたロール名。 テンプレートからエンベロープを作成するときに使用します。

ユーザーID
template.templateCreatedBy.partyId integer

ユーザーの一意の ID。

名前
template.templateCreatedBy.firstName string

ユーザーの名。

template.templateCreatedBy.lastName string

ユーザーの姓。

Email
template.templateCreatedBy.emailId string

ユーザーの電子メール アドレス。

テンプレート フィールド
allfields array of object

テンプレートで定義されているすべての署名フィールドとフォーム フィールドの一覧。

フィールド ID
allfields.fieldTagId integer

フィールドの一意識別子。

テンプレート識別子
allfields.templateId integer

このフィールドが属するテンプレートの ID。

会社 ID
allfields.companyId integer

このフィールドが属する会社アカウント。

フィールドの型
allfields.fieldType string

フィールドの型 (例: signfield、initialfield、textfield、datefield、checkboxfield、securedfield、attachmentfield)。

ページ番号
allfields.documentPageNumber integer

このフィールドが配置されているドキュメントのページ番号。

責任当事者
allfields.partyResponsible integer

このフィールドの入力を担当するパーティ シーケンス番号。

パーティー シーケンス
allfields.partyResponsibleSequence integer

責任者の順序の位置。

フィールド ドキュメント ID
allfields.docFieldId string

このフィールドのドキュメント レベルの識別子。

依存している
allfields.dependent boolean

このフィールドの表示が別のフィールドの値に依存するかどうかを示します。

タブ オーダー
allfields.tabOrder integer

フィールド間を移動するためのタブ オーダー。

必須
allfields.required boolean

ドキュメントに署名する前に、このフィールドを入力する必要があるかどうかを示します。

ユーザー設定フィールド名
allfields.customFieldName string

このフィールドに割り当てられたカスタム名。

[すべて共有]
allfields.shareAll boolean

このフィールドがすべてのユーザーと共有されているかどうかを示します。

編集を許可する
allfields.allowEdit boolean

このフィールドを受信者が編集できるかどうかを示します。

テキスト フィールド名
allfields.textfieldName string

テキスト フィールドのラベル (fieldType が 'textfield' の場合に適用されます)。

価値
allfields.value string

フィールドの入力済みまたは入力済みの値。

フォント サイズ
allfields.fontSize integer

このフィールドのテキストに使用されるフォント サイズ。

フォントの色
allfields.fontColor string

このフィールドのテキストに使用されるフォントの色 (#000000 など)。

[読み取り専用]
allfields.readOnly boolean

フィールドが読み取り専用で、受信者が編集できないかどうかを示します。

複数行
allfields.multiLine boolean

テキスト フィールドが複数行の入力を受け入れるかどうかを示します (fieldType が 'textfield' の場合に適用されます)。

文字数制限
allfields.characterLimit integer

フィールドで使用できる最大文字数 (fieldType が 'textfield' の場合に適用されます)。

日付フィールド名
allfields.datefieldName string

日付フィールドのラベル (fieldType が 'datefield' の場合に適用されます)。

日付形式
allfields.dateFormat string

このフィールドで使用される日付形式 (MM/DD/YYYY など) (fieldType が 'datefield' の場合に適用されます)。

チェックボックス名
allfields.cbname string

チェックボックス フィールドのラベル (fieldType が 'checkboxfield' の場合に適用されます)。

チェックボックス グループ
allfields.cbgroup string

このチェック ボックスのグループ名 (fieldType が 'checkboxfield' の場合に適用されます)。

確認済み
allfields.checked boolean

チェック ボックスが既定でオンになっているかどうかを示します (fieldType が 'checkboxfield' の場合に適用されます)。

セキュリティで保護されたフィールド名
allfields.securedfieldName string

セキュリティで保護されたフィールドのラベル (fieldType が 'securedfield' の場合に適用されます)。

表示する文字
allfields.charToDisplay integer

セキュリティで保護されたフィールド値の末尾に表示するマスクされていない文字の数 (fieldType が 'securedfield' の場合に適用されます)。

署名 ID
allfields.signatureId string

この署名フィールドに適用される署名の ID (fieldType が 'signfield' の場合に適用されます)。

初期イメージ
allfields.initialImage string

このフィールドに適用されるイニシャルの画像データ (fieldType が 'initialfield' の場合に適用されます)。

添付ファイル フィールド名
allfields.attachmentfieldName string

添付ファイル フィールドの名前 (fieldType が 'attachmentfield' の場合に適用されます)。

添付ファイルの説明
allfields.attachmentfieldDescription string

添付する内容の説明 (fieldType が 'attachmentfield' の場合に適用されます)。

URL からエンベロープを作成する

パブリックにアクセスできる PDF URL を使用して封筒を作成して送信します。 署名プロセスを開始するには、ドキュメントの URL と受信者の詳細を指定します。

パラメーター

名前 キー 必須 説明
封筒名
folderName True string

この封筒の名前。

入力の種類
inputType string

文書のソース形式を指定します。 ファイル URL を提供する URL に設定し、Base64 でエンコードされたファイルコンテンツを提供する場合は base64 に設定します。

ファイル URL
fileUrls True array of string

このエンベロープに追加するドキュメントを指す、パブリックにアクセス可能な URL の配列。

ファイル名
fileNames True array of string

ファイル URL と同じ順序で、各ドキュメントの表示名の配列。

名前
firstName True string

受信者の名。

lastName True string

受信者の姓。

Emailアドレス
emailId True string

受信者のメール アドレス。

アクセス許可
permission True string
順番
sequence True integer

このフィールドを使用して、受信者のリスト内の受信者にシーケンス番号を割り当てます。 1、2、3、4 など、1 から始まる各パーティに一意のシーケンス番号を使用します。署名ワークフローに 1 人のユーザーが複数回表示される場合は、受信者が繰り返されるたびに異なるシーケンスを割り当ててください。

signerAuthLevels
signerAuthLevel string

署名者が検証のために利用する認証のレベル

プレースホルダー
isPlaceholder boolean

このフィールドを使用して、パーティがプレースホルダーであることを開始します。 注: 1。 firstName、lastName、emailId パラメーターの値は、このパーティの空白にする必要があります。 2. プレースホルダーを追加するには、1 人の受信者を 'PARTY_ASSIGNER' アクセス許可で再実行する必要があります。

受信者ロール
partyRole string

このフィールドを使用して、プレースホルダーのロールを割り当てます。

名前の変更を許可する
allowNameChange string

値には true または false を指定できます。署名プロセスを完了する前に、署名者が姓と名を更新できるようにするには、このパラメーターを使用します。

ワークフロー シーケンス
workflowSequence integer

この受信者にワークフロー シーケンス番号を割り当てます。 サインイン シーケンスが有効になっている場合、受信者は昇順で署名の招待を受け取ります。

ホスト電子メール ID
hostEmailId string

In-Person 管理者の電子メール アドレス。

アクセス コード
userDefinedAccessCode string

認証用に "signerAuthLevel" 値が "ユーザー定義アクセス コード" として設定されている場合、パラメーターには Access Code が含まれます。 注: 1。 コードでは大文字と小文字は区別されません。 2. システムはこのコードを送信しないため、署名者と直接このコードを共有する必要があります。 3. アクセス コードには、アルファベット、数字、および次の特殊文字を含めることができます: @、&{,}、%、(、~、|,!,+、^)。

パーティーは電子メール グループです
partyIsEmailGroup boolean

パーティーを一括で作成する場合は、このパラメーターを使用します。 メモ: このパラメーターが true の場合、このパーティの firstName、lastName、emailId は無視されます。

電子メール グループ ID
emailGroupId integer

一括作成に使用するグループ ID を電子メールで渡します。

シングル 署名者の一括
allowSingleSignerInBulk boolean

このパラメーターを使用して、1 人のユーザーのみが電子メール グループにサインインできるようにします。

ダイヤル コード
dialingCode string

このフィールドを使用して、受信者のリスト内の受信者に携帯電話番号プレフィックスである国のダイヤルイン コードを割り当てます。

携帯電話番号
mobileNumber string

このフィールドを使用して、受信者の一覧で受信者に携帯電話番号を割り当てます。

フィールド
Fields object
今すぐ送信
sendNow boolean

有効にすると、Foxit eSign は直ちに一意の署名リンクを各受信者のメール アドレスに送信します。 封筒を下書きとして保存するには、これを無効にします。

埋め込み署名セッションの作成
createEmbeddedSigningSession True boolean

署名セッション トークンは、受信者に電子メールを送信せずに生成されます。

すべてのパーティの埋め込み署名セッションを作成する
createEmbeddedSigningSessionForAllParties boolean

true に設定すると、エンベロープ内のすべての受信者に対して埋め込み署名 URL が生成されます。

テキスト タグの処理
processTextTags True boolean

値には true または false を指定できます。 このフィールドは、Foxit eSign がテキスト タグのドキュメントを解析して Foxit eSign フィールドに変換する必要があるかどうかを判断するために使用されます。

Acro フィールドの処理
processAcroFields True boolean

このフィールドは、Foxit eSign が AcroFields のドキュメントを解析して Foxit eSign フィールドに変換する必要があるかどうかを判断するために使用されます。

サインイン シーケンス
signInSequence boolean

このフィールドは、受信者が順番に封筒ドキュメントに署名するかどうかを決定するために使用されます。 false の場合、すべての受信者が同時に招待メールを受信します。 true の場合、各受信者は、前の受信者が必要なタスク (ドキュメントへの署名やフィールドの入力など) を完了した後、連続して招待メールを受信します。

In Person Enable
inPersonEnable boolean

このフィールドは、任意のデバイスで数分で簡単に完了できる直接署名プロセスを開始するために使用され、必要に応じて電子メール ベースの署名を回避します。 false の場合、すべての受信者は同時に招待メールを受信します。 true の場合、社内管理者は署名者の署名プロセスを開始するための招待メールを受け取ります。

受信者のパーティを修正する
fixRecipientParties boolean

true の場合、埋め込み送信ビューでは、この要求の一部として既に追加されているエンベロープのパーティを変更できません。

ドキュメントの修正
fixDocuments boolean

true の場合、埋め込み送信では、この要求の一部として既に追加されている封筒のドキュメントを変更できません。

成功 URL の送信
sendSuccessUrl string

埋め込み送信ビューでフォルダーを正常に送信した後に署名者がリダイレクトされるランディング ページの絶対 URL を入力します。

エラー URL の送信
sendErrorUrl string

埋め込み送信ビューでのフォルダーの送信中にエラーが発生した場合に署名者がリダイレクトされるランディング ページの絶対 URL を入力します。

埋め込み送信セッションを作成する
createEmbeddedSendingSession boolean

true に設定すると、埋め込みトークンが生成され、Foxit eSign のドキュメント準備ビューが開きます。

埋め込み署名者の電子メール ID
embeddedSignersEmailIds array of string

埋め込み署名セッションを作成する必要がある受信者の電子メール ID の配列。 パーティの一覧に追加された受信者の電子メール ID。

成功 URL に署名する
signSuccessUrl string

埋め込み署名ビューに正常にサインインした後にリダイレクトされる署名者の絶対 URL を入力します。

辞退 URL に署名する
signDeclineUrl string

埋め込み署名ビューへのサインインを拒否した場合にリダイレクトされる署名者の絶対 URL を入力します。

後で URL に署名する
signLaterUrl string

埋め込み署名ビューで後でサインインすることを選択した場合にリダイレクトされる署名者の絶対 URL を入力します。

エラー URL に署名する
signErrorUrl string

埋め込み署名ビューでドキュメントの署名中にエラーが発生した場合にリダイレクトされる署名者の絶対 URL を入力します。

今すぐ送信と埋め込み署名セッションを許可する
allowSendNowAndEmbeddedSigningSession boolean

true に設定すると、Foxit eSign は一意の署名リンクを各受信者に送信します。 これは、パラメーター sendNow と createEmbeddedSigningSession が true の場合にのみ適用されます。

高度な電子メール検証
allowAdvancedEmailValidation boolean

true に設定されている場合は、パーティーの電子メール アドレスを検証します。

Sign Success Url All Parties
signSuccessUrlAllParties boolean

true に設定すると、署名に成功した後、署名者は signSuccessUrl で指定された URL にリダイレクトされます。 これは、sendNow が true の場合にのみ適用されます。

電子メール テンプレート ID
emailTemplateId integer

電子メール テンプレート ID を渡して、既定の電子メール テンプレート以外の電子メール テンプレートを送信します。

署名者命令 ID
signerInstructionId integer

既定の署名者命令以外の署名者命令を送信する命令 ID を渡します。

確認命令 ID
confirmationInstructionId string

確認指示 ID を渡して、既定の確認手順以外の確認指示を送信します。

テーマの色
themeColor string

CSS 値を入力してテーマの色を設定します。

セッションの有効期限
sessionExpire boolean

埋め込み署名セッションの有効期限を開始するには、true に設定します。

有効期限
expiry integer

sessionExpire が true の場合は必須。 埋め込み署名セッションの有効期限のミリ秒単位の期間を入力します。

依存フィールド名
dependentFieldName True string

親フィールドによって表示が制御されるフィールドの名前。

親フィールド名
parentFieldName True string

依存フィールドの表示を制御する値を持つ親フィールドの名前。 サポートされている親フィールドの種類: textfield、textbox、checkbox、radiobutton、dropdown。

親フィールド値
parentFieldValue True string

依存フィールドが表示されるようにトリガーする親フィールドの値。 チェック ボックスとラジオ ボタン フィールドの場合は、オンまたはオフを使用します。

オプション
options True string

テキスト ベースの親フィールドの追加の一致オプション。 受け入れ可能な値: isblank、allowNull、contains。

Metadata
metadata object

これはキーと値のペアである必要があります。 最大 1,000 個のキー値ペアを使用できます。

送信者の電子メール
senderEmail string

このドキュメント フォルダーを受信者に送信するために使用する、アカウント内の別のユーザーの電子メールを入力します。

[自分の追加] ボタンを非表示にする
hideAddMeButton boolean

true の場合、埋め込み送信セッションの受信者の [自分の追加] ボタンが非表示になります。

[新しい追加] ボタンを非表示にする
hideAddNewButton boolean

true の場合、埋め込み送信セッションの受信者パーティの [新規追加] ボタンが非表示になります。

[グループの追加] ボタンを非表示にする
hideAddGroupButton boolean

true の場合、埋め込み送信セッションの受信者パーティの [グループの追加] ボタンが非表示になります。

受信者のフィールド名を非表示にする
hideFieldNameForRecipients boolean

データ入力フィールドと高度なフィールドの受信者のフィールド名を非表示にします。 (オプション ボタン、チェックボックス、イメージ、ハイパーリンクを除く)。

チェック ボックスの罫線を非表示にする
hideCheckboxBorder boolean

チェック ボックスの罫線は、実行されたドキュメントでは非表示になります。

署名者の選択オプションを非表示にする
hideSignerSelectOption boolean

true の場合、埋め込み送信セッションの受信者の [既存の署名者名/電子メール] 入力ボックスが非表示になります。

署名者アクションを非表示にする
hideSignerActions boolean

true の場合、埋め込み送信セッションの受信者に対する署名者の "編集"、"変更"、"削除" アクションが非表示になります。

送信者名を非表示にする
hideSenderName boolean

true の場合、埋め込み送信セッションの受信者パーティの送信者名が非表示になります。

フォルダー名を非表示にする
hideFolderName boolean

true の場合、両方の埋め込みセッションのナビゲーションでフォルダー名が非表示になります。

ドキュメント名を非表示にする
hideDocumentsName boolean

true の場合、両方の埋め込みセッションでドキュメント名が非表示になります。

署名の拒否を非表示にする
hideDeclineToSign boolean

true の場合、署名者の [署名を辞退する] オプションが非表示になります。

その他のアクションを非表示にする
hideMoreAction boolean

true の場合、送信/署名セッションの [その他のアクション] ボタンが非表示になります。 "今すぐ送信" の場合: true の場合、何も非表示になりません。

送信ボタンを非表示にする
hideSendButton boolean

true の場合、埋め込み送信セッションの [送信] ボタンが非表示になります。

次の必須 Fieldbtn を非表示にする
hideNextRequiredFieldbtn boolean

true に設定すると、署名者を次の必須フィールドに移動するナビゲーション ボタンが非表示になります。

必須の両方の埋め込みセッション
requiredBothEmbeddedSession boolean

true の場合、埋め込みの送信 URL と署名 URL が生成されます。

封筒のパスワード
folderPassword string

このパスワードは、デジタル署名されたドキュメントを開くために署名者/作成者が必要とします。 パラメーターを空白のままにした場合、デジタル署名されたドキュメントを開くためにパスワードは必要ありません。

ステップ バイ ステップを有効にする
enableStepByStep boolean

埋め込み送信セッションでステップ バイ ステップ アクションを有効にする。

[パーティーの追加] オプションを非表示にする
hideAddPartiesOption boolean

true の場合、下書きおよびテンプレート作成モードでパーティオプションを追加するオプションが非表示になります。

セルフ サイン
selfSign boolean

API を使用して埋め込みセルフ サインを有効にします。 このパラメーターは、createEmbeddedSendingSession パラメーターが true の場合にのみ適用されます。

セルフ 署名者の成功 URL
selfSignerSuccessUrl string

Web サイト/アプリケーションのランディング ページの絶対 URL を入力します。この URL は、埋め込み送信ビューでフォルダーを送信した後にユーザーがリダイレクトされます。

返品

名前 パス 説明
ID
folder.folderId integer

新しく作成された封筒の一意の ID。 これを後続のアクションで使用して、このエンベロープを参照します。

名前
folder.folderName string

新しく作成された封筒の名前。

カスタム名
folder.folderCustomName string

封筒のカスタム名。

パスワード
folder.folderPassword string

封筒のアクセス パスワード (設定されている場合)。

作成者 ID
folder.folderAuthorId integer

エンベロープ作成者の一意識別子。

作成者名
folder.folderAuthorFirstName string

封筒作成者の名。

作成者の姓
folder.folderAuthorLastName string

封筒作成者の姓。

作成者の電子メール
folder.folderAuthorEmail string

封筒作成者のメール アドレス。

Creator ロール
folder.folderAuthorRole string

封筒作成者の役割。

会社 ID
folder.folderCompanyId integer

封筒を所有する会社の一意識別子。

作成日
folder.folderCreationDate integer

エンベロープが作成された日付 (Unix タイムスタンプ (ミリ秒)。

送信日
folder.folderSentDate integer

エンベロープが送信された日付 (Unix タイムスタンプ (ミリ秒)。

地位
folder.folderStatus string

封筒の現在の状態。

ユーザー設定フィールド 1
folder.custom_field1 string

封筒の最初のユーザー設定メタデータ フィールド。

ユーザー設定フィールド 2
folder.custom_field2 string

封筒の 2 番目のユーザー設定メタデータ フィールド。

Metadata
folder.metadata string

エンベロープに関連付けられているカスタム メタデータ。

ドキュメント ID
folder.folderDocumentIds array of integer

封筒に含まれるドキュメント ID の一覧。

ドキュメント​
folder.documentsList array of object

封筒内のドキュメントの一覧。

ドキュメント ID
folder.documentsList.documentId integer

ドキュメントの一意識別子。

コントラクト ID
folder.documentsList.contractId integer

コントラクトの一意識別子。

会社 ID
folder.documentsList.companyId integer

会社の一意識別子。

作成者
folder.documentsList.contractCreatedBy integer

コントラクトを作成したユーザーのユーザー ID。

作成日
folder.documentsList.contractCreatedOn string

コントラクトが作成された日時。

コントラクトの種類
folder.documentsList.contractType string

コントラクトの型。

コントラクトの状態
folder.documentsList.contractStatus string

コントラクトの現在の状態。

編集可能
folder.documentsList.editable boolean

アイテムが編集可能かどうかを示します。

バージョン ID
folder.documentsList.contractVersionId integer

コントラクト バージョンの一意識別子。

バージョン名
folder.documentsList.contractVersionName string

コントラクト バージョンの名前。

バージョンの説明
folder.documentsList.contractVersionDesc string

コントラクト バージョンの説明。

作成者のバージョン
folder.documentsList.versionCreatedby integer

このバージョンを作成したユーザーのユーザー ID。

作成日のバージョン
folder.documentsList.versionCreatedOn string

このバージョンが作成された日付と時刻。

バージョン番号
folder.documentsList.contractVersionNumber integer

コントラクトのバージョン番号。

トランザクション ソース
folder.documentsList.contractTransactionSource string

コントラクト トランザクションを開始したソース システム。

受取人
folder.folderRecipientParties array of object

この封筒の受信者の一覧。

受信者 ID
folder.folderRecipientParties.partyId integer

受信者の一意識別子。

受信者 ID
folder.folderRecipientParties.partyDetails.partyId integer

受信者の一意識別子。

名前
folder.folderRecipientParties.partyDetails.firstName string

受信者の名前。

folder.folderRecipientParties.partyDetails.lastName string

受信者の姓。

Emailアドレス
folder.folderRecipientParties.partyDetails.emailId string

受信者のメール アドレス。

プレースホルダー
folder.folderRecipientParties.partyDetails.placeholder boolean

このパーティがプレースホルダーの受信者かどうかを示します。

住所
folder.folderRecipientParties.partyDetails.address string

受信者の物理アドレス。

作成日
folder.folderRecipientParties.partyDetails.dateCreated integer

レコードが作成された日付 (Unix タイムスタンプ (ミリ秒)。

電子メールをオプトアウトする
folder.folderRecipientParties.partyDetails.optOutEmails boolean

受信者が電子メール通知をオプトアウトしたかどうかを示します。

一意の受信者 ID
folder.folderRecipientParties.partyDetails.uniquePartyId string

この受信者の一意のシステム識別子。

認証レベル
folder.folderRecipientParties.partyDetails.authenticationLevel string

この受信者に必要な認証方法。

パスワードの更新日
folder.folderRecipientParties.partyDetails.passwordUpdateDate string

パスワードが最後に更新された日付。

パスワードの更新状態
folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

パスワードが更新されたかどうかを示します。

会社 ID
folder.folderRecipientParties.partyDetails.companyId integer

会社の一意識別子。

ユーザー ロール
folder.folderRecipientParties.partyDetails.userRole string

ユーザーに割り当てられたロール。

部門
folder.folderRecipientParties.partyDetails.department string

ユーザーが属している部署。

Title
folder.folderRecipientParties.partyDetails.title string

ユーザーの役職。

アクティブ
folder.folderRecipientParties.partyDetails.active boolean

ユーザーまたはレコードがアクティブかどうかを示します。

ロケール
folder.folderRecipientParties.partyDetails.requestLocale string

ユーザーのロケール設定。

Dept と共有する
folder.folderRecipientParties.partyDetails.share_among_department boolean

部門全体で封筒を共有するかどうかを示します。

ダイヤル コード
folder.folderRecipientParties.partyDetails.dialingCode string

電話番号の国際ダイヤル コード。

携帯電話番号
folder.folderRecipientParties.partyDetails.mobileNumber string

携帯電話番号。

状態フィルター
folder.folderRecipientParties.partyDetails.docStatusFilter string

ドキュメントの状態のフィルター。

日付フィルター
folder.folderRecipientParties.partyDetails.docDateFilter string

ドキュメントの日付のフィルター。

フィールド アクセスのセキュリティ保護
folder.folderRecipientParties.partyDetails.userSecureFieldAccess boolean

ユーザーがセキュリティで保護されたフィールドにアクセスできるかどうかを示します。

サイドバーを展開する
folder.folderRecipientParties.partyDetails.expandSidebar boolean

サイドバーが既定で展開されているかどうかを示します。

Adv. 電子メールの検証
folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation boolean

電子メールの高度な検証が有効かどうかを示します。

マネージャー ID
folder.folderRecipientParties.partyDetails.managerId string

ユーザーのマネージャーの一意識別子。

ログイン数
folder.folderRecipientParties.partyDetails.loginCount integer

ユーザーがログインした回数。

パスワード リセットの電子メール
folder.folderRecipientParties.partyDetails.sendMailForPasswordReset boolean

パスワード リセット電子メールを送信するかどうかを示します。

部門 ID
folder.folderRecipientParties.partyDetails.departmentId string

部署の一意識別子。

プライマリ企業
folder.folderRecipientParties.partyDetails.userPrimaryCompany integer

ユーザーに関連付けられているプライマリ企業。

デバイスの種類
folder.folderRecipientParties.partyDetails.deviceType string

使用されるデバイスの種類。

デバイス トークン
folder.folderRecipientParties.partyDetails.deviceToken string

デバイスのプッシュ通知トークン。

協力会社の説明
folder.folderRecipientParties.partyDetails.subcontractorDescription string

下請け業者または外部署名者の説明。

協力会社組織
folder.folderRecipientParties.partyDetails.subcontractorOrganization string

下請け業者または外部署名者の組織名。

協力会社の追加日
folder.folderRecipientParties.partyDetails.subcAddedDate integer

下請け業者が追加された日付 (Unix タイムスタンプ (ミリ秒)。

Source
folder.folderRecipientParties.partyDetails.source string

外部署名者が追加されたソース システム。

ダイヤル コード
folder.folderRecipientParties.dialingCode string

電話番号の国際ダイヤル コード。

携帯電話番号
folder.folderRecipientParties.mobileNumber string

携帯電話番号。

署名の種類
folder.folderRecipientParties.signerSignatureType string

署名者が使用する署名の種類。

Permissions
folder.folderRecipientParties.contractPermissions string

コントラクトに対してこのパーティに付与されたアクセス許可。

署名順序
folder.folderRecipientParties.partySequence integer

この受信者の署名順序シーケンス番号。

ワークフロー シーケンス
folder.folderRecipientParties.workflowSignSequence integer

ワークフロー署名シーケンス番号。

封筒 ID
folder.folderRecipientParties.envelopeId integer

封筒の一意識別子。

受信者の会社 ID
folder.folderRecipientParties.partyCompanyId integer

この受信者に関連付けられている会社の一意識別子。

共有モード
folder.folderRecipientParties.sharingMode string

このエンベロープの共有モード。

受信者アクセス URL
folder.folderRecipientParties.folderAccessURL string

受信者が封筒にアクセスして署名するために使用できる URL。

セキュリティ モード
folder.folderRecipientParties.securityMode string

このエンベロープに適用されるセキュリティ モード。

コメント
folder.folderRecipientParties.extraComments string

封筒に含まれる追加のコメント。

名前の変更を許可する
folder.folderRecipientParties.allowNameChange boolean

受信者が自分の名前を更新できるかどうかを示します。

更新された名前
folder.folderRecipientParties.signerNameUpdated boolean

署名者が自分の名前を更新したかどうかを示します。

署名者の認証レベル
folder.folderRecipientParties.signerAuthenticationLevel string

署名者に必要な認証レベル。

アクセス コード
folder.folderRecipientParties.userDefinedAccessCode string

署名者に対して定義されたカスタム アクセス コード。

署名 ID
folder.folderRecipientParties.signatureId string

署名の一意識別子。

受信者ロール
folder.folderRecipientParties.partyRole string

署名ワークフローでこの受信者に割り当てられたロール。

会社フィールド
folder.folderRecipientParties.companyFieldValue string

署名の会社名フィールドの値。

タイトル フィールド
folder.folderRecipientParties.titleFieldValue string

署名のタイトル フィールドの値。

署名の理由
folder.folderRecipientParties.reasonSigning string

受信者がドキュメントに署名する理由。

支払フィールドの追加
folder.folderRecipientParties.payFieldAdded boolean

支払フィールドが追加されたかどうかを示します。

受取 人
folder.folderRecipientParties.payee boolean

この受信者が支払い先かどうかを示します。

定期支払い
folder.folderRecipientParties.recurringFieldExist boolean

定期的な支払いフィールドが存在するかどうかを示します。

印刷と署名の完了
folder.folderRecipientParties.printAndSignCompleted boolean

印刷と署名のプロセスが完了したかどうかを示します。

有料
folder.folderRecipientParties.paid boolean

支払いが完了したかどうかを示します。

省略可能な署名者許可
folder.folderRecipientParties.allowOptionalSigner boolean

この受信者が省略可能な署名者であるかどうかを示します。

省略可能な署名者
folder.folderRecipientParties.optionalSigners array of integer

この封筒のオプションの署名者パーティー ID の一覧。

作成者の署名 URL
folder.folderAccessURLForAuthor string

送信者がエンベロープへのアクセスに使用できる URL。

下書きアクセス URL
folder.draftFolderAccessURL string

封筒の下書きバージョンへのアクセスに使用される URL。

ボードルーム署名
folder.boardRoomSign boolean

ボード ルーム署名モードが有効かどうかを示します。

ロゴを含める
folder.includeLogo boolean

会社のロゴが電子メールに含まれているかどうかを示します。

ボタンの背景色
folder.email_btnBgColor string

メール ボタンの背景色。

ボタンテキストの色
folder.email_btnTxtColor string

電子メール ボタンのテキストの色。

電子メール のロゴ
folder.emailTemplateLogo string

電子メール テンプレートで使用されるロゴ URL。

電子メール テンプレート ID
folder.emailTemplateId integer

電子メール テンプレートの一意識別子。

電子メール ヘッダー
folder.emailHeader string

通知メールで使用されるヘッダー テキスト。

電子メール フッター
folder.emailFooter string

通知メールで使用されるフッター テキスト。

スケジュールされた消去
folder.purgeFlag boolean

エンベロープの消去がスケジュールされているかどうかを示します。

消去の開始日
folder.purgeStartDate string

消去の開始をスケジュールする日付。

終了日を消去する
folder.purgeEndDate string

消去が完了するようにスケジュールされている日付。

一括送信 ID
folder.bulkId integer

一括送信操作の一意識別子。

署名順序を適用する
folder.enforceSignWorkflow boolean

受信者が定義済みのシーケンスにサインインする必要があるかどうかを示します。

現在のステップ
folder.currentWorkflowStep integer

署名ワークフローの現在のステップ。

トランザクション ソース
folder.transactionSource string

このトランザクションを開始したソース システム。

編集可能
folder.editable boolean

アイテムが編集可能かどうかを示します。

In-Person 署名
folder.inPersonSignable boolean

封筒を個人でサインインできるかどうかを示します。

アラームをオーバーライドする
folder.overrideAccountReminders boolean

アカウント レベルのアラーム設定をオーバーライドするかどうかを示します。

委任のオーバーライド
folder.overrideAccountRecipientDelegation boolean

アカウント レベルの委任設定がオーバーライドされるかどうかを示します。

委任を許可する
folder.allowRecipientsToDelegate boolean

受信者が署名の委任を許可されているかどうかを示します。

ID
folder.envelopeId integer

封筒の一意識別子。

名前
folder.envelopeName string

封筒の名前。

発信元 ID
folder.envelopeOriginatorId integer

エンベロープを作成したユーザーの一意識別子。

会社 ID
folder.envelopeCompanyId integer

封筒を所有する会社の一意識別子。

Date
folder.envelopeDate integer

エンベロープが作成された日付 (Unix タイムスタンプ (ミリ秒)。

共有日
folder.envelopeSharedDate integer

エンベロープが共有された日付 (Unix タイムスタンプ (ミリ秒)。

地位
folder.envelopeStatus string

封筒の現在の状態。

コントラクト ID
folder.envelopeContractIds array of integer

このエンベロープに関連付けられているコントラクト ID の一覧。

受信者のアクセス許可
folder.envelopePartyPermissions array of object

この封筒の受信者のアクセス許可の一覧。

受信者 ID
folder.envelopePartyPermissions.partyId integer

受信者の一意識別子。

受信者 ID
folder.envelopePartyPermissions.partyDetails.partyId integer

受信者の一意識別子。

名前
folder.envelopePartyPermissions.partyDetails.firstName string

受信者の名前。

folder.envelopePartyPermissions.partyDetails.lastName string

受信者の姓。

Emailアドレス
folder.envelopePartyPermissions.partyDetails.emailId string

受信者のメール アドレス。

プレースホルダー
folder.envelopePartyPermissions.partyDetails.placeholder boolean

このパーティがプレースホルダーの受信者かどうかを示します。

住所
folder.envelopePartyPermissions.partyDetails.address string

受信者の物理アドレス。

作成日
folder.envelopePartyPermissions.partyDetails.dateCreated integer

レコードが作成された日付 (Unix タイムスタンプ (ミリ秒)。

電子メールをオプトアウトする
folder.envelopePartyPermissions.partyDetails.optOutEmails boolean

受信者が電子メール通知をオプトアウトしたかどうかを示します。

一意の受信者 ID
folder.envelopePartyPermissions.partyDetails.uniquePartyId string

この受信者の一意のシステム識別子。

認証レベル
folder.envelopePartyPermissions.partyDetails.authenticationLevel string

この受信者に必要な認証方法。

パスワードの更新日
folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string

パスワードが最後に更新された日付。

パスワードの更新状態
folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean

パスワードが更新されたかどうかを示します。

会社 ID
folder.envelopePartyPermissions.partyDetails.companyId integer

会社の一意識別子。

ユーザー ロール
folder.envelopePartyPermissions.partyDetails.userRole string

ユーザーに割り当てられたロール。

部門
folder.envelopePartyPermissions.partyDetails.department string

ユーザーが属している部署。

Title
folder.envelopePartyPermissions.partyDetails.title string

ユーザーの役職。

アクティブ
folder.envelopePartyPermissions.partyDetails.active boolean

ユーザーまたはレコードがアクティブかどうかを示します。

ロケール
folder.envelopePartyPermissions.partyDetails.requestLocale string

ユーザーのロケール設定。

Dept と共有する
folder.envelopePartyPermissions.partyDetails.share_among_department boolean

部門全体で封筒を共有するかどうかを示します。

ダイヤル コード
folder.envelopePartyPermissions.partyDetails.dialingCode string

電話番号の国際ダイヤル コード。

携帯電話番号
folder.envelopePartyPermissions.partyDetails.mobileNumber string

携帯電話番号。

状態フィルター
folder.envelopePartyPermissions.partyDetails.docStatusFilter string

ドキュメントの状態のフィルター。

日付フィルター
folder.envelopePartyPermissions.partyDetails.docDateFilter string

ドキュメントの日付のフィルター。

フィールド アクセスのセキュリティ保護
folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess boolean

ユーザーがセキュリティで保護されたフィールドにアクセスできるかどうかを示します。

サイドバーを展開する
folder.envelopePartyPermissions.partyDetails.expandSidebar boolean

サイドバーが既定で展開されているかどうかを示します。

Adv. 電子メールの検証
folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation boolean

電子メールの高度な検証が有効かどうかを示します。

マネージャー ID
folder.envelopePartyPermissions.partyDetails.managerId string

ユーザーのマネージャーの一意識別子。

ログイン数
folder.envelopePartyPermissions.partyDetails.loginCount integer

ユーザーがログインした回数。

パスワード リセットの電子メール
folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset boolean

パスワード リセット電子メールを送信するかどうかを示します。

部門 ID
folder.envelopePartyPermissions.partyDetails.departmentId string

部署の一意識別子。

プライマリ企業
folder.envelopePartyPermissions.partyDetails.userPrimaryCompany integer

ユーザーに関連付けられているプライマリ企業。

デバイスの種類
folder.envelopePartyPermissions.partyDetails.deviceType string

使用されるデバイスの種類。

デバイス トークン
folder.envelopePartyPermissions.partyDetails.deviceToken string

デバイスのプッシュ通知トークン。

協力会社の説明
folder.envelopePartyPermissions.partyDetails.subcontractorDescription string

下請け業者または外部署名者の説明。

協力会社組織
folder.envelopePartyPermissions.partyDetails.subcontractorOrganization string

下請け業者または外部署名者の組織名。

協力会社の追加日
folder.envelopePartyPermissions.partyDetails.subcAddedDate integer

下請け業者が追加された日付 (Unix タイムスタンプ (ミリ秒)。

Source
folder.envelopePartyPermissions.partyDetails.source string

外部署名者が追加されたソース システム。

ダイヤル コード
folder.envelopePartyPermissions.dialingCode string

電話番号の国際ダイヤル コード。

携帯電話番号
folder.envelopePartyPermissions.mobileNumber string

携帯電話番号。

署名の種類
folder.envelopePartyPermissions.signerSignatureType string

署名者が使用する署名の種類。

Permissions
folder.envelopePartyPermissions.contractPermissions string

コントラクトに対してこのパーティに付与されたアクセス許可。

署名順序
folder.envelopePartyPermissions.partySequence integer

この受信者の署名順序シーケンス番号。

ワークフロー シーケンス
folder.envelopePartyPermissions.workflowSignSequence integer

ワークフロー署名シーケンス番号。

封筒 ID
folder.envelopePartyPermissions.envelopeId integer

封筒の一意識別子。

受信者の会社 ID
folder.envelopePartyPermissions.partyCompanyId integer

この受信者に関連付けられている会社の一意識別子。

共有モード
folder.envelopePartyPermissions.sharingMode string

このエンベロープの共有モード。

受信者アクセス URL
folder.envelopePartyPermissions.folderAccessURL string

受信者が封筒にアクセスして署名するために使用できる URL。

セキュリティ モード
folder.envelopePartyPermissions.securityMode string

このエンベロープに適用されるセキュリティ モード。

コメント
folder.envelopePartyPermissions.extraComments string

封筒に含まれる追加のコメント。

名前の変更を許可する
folder.envelopePartyPermissions.allowNameChange boolean

受信者が自分の名前を更新できるかどうかを示します。

更新された名前
folder.envelopePartyPermissions.signerNameUpdated boolean

署名者が自分の名前を更新したかどうかを示します。

署名者の認証レベル
folder.envelopePartyPermissions.signerAuthenticationLevel string

署名者に必要な認証レベル。

アクセス コード
folder.envelopePartyPermissions.userDefinedAccessCode string

署名者に対して定義されたカスタム アクセス コード。

署名 ID
folder.envelopePartyPermissions.signatureId string

署名の一意識別子。

受信者ロール
folder.envelopePartyPermissions.partyRole string

署名ワークフローでこの受信者に割り当てられたロール。

会社フィールド
folder.envelopePartyPermissions.companyFieldValue string

署名の会社名フィールドの値。

タイトル フィールド
folder.envelopePartyPermissions.titleFieldValue string

署名のタイトル フィールドの値。

署名の理由
folder.envelopePartyPermissions.reasonSigning string

受信者がドキュメントに署名する理由。

支払フィールドの追加
folder.envelopePartyPermissions.payFieldAdded boolean

支払フィールドが追加されたかどうかを示します。

受取 人
folder.envelopePartyPermissions.payee boolean

この受信者が支払い先かどうかを示します。

定期支払い
folder.envelopePartyPermissions.recurringFieldExist boolean

定期的な支払いフィールドが存在するかどうかを示します。

印刷と署名の完了
folder.envelopePartyPermissions.printAndSignCompleted boolean

印刷と署名のプロセスが完了したかどうかを示します。

有料
folder.envelopePartyPermissions.paid boolean

支払いが完了したかどうかを示します。

認証レベル
folder.envelopeAuthenticationLevel string

エンベロープに必要な認証レベル。

シングル 署名者の一括
folder.allowSingleSignerInBulk boolean

シングル 署名者が一括送信モードで許可されるかどうかを示します。

File-Based の名前付け
folder.folderNameBasedOnFileNaming boolean

フォルダー名がファイル名に基づいているかどうかを示します。

ドキュメント File-Based 名
folder.documentNameBasedOnFileNaming boolean

ドキュメント名がファイル名に基づいているかどうかを示します。

証明書 File-Based 名
folder.certificateNameBasedOnFileNaming boolean

証明書名がファイル名に基づいているかどうかを示します。

Pre-Exec ファイルの名前付け
folder.enableFileNamingBeforeExecution boolean

ドキュメントの実行前にファイルの名前付けを有効にするかどうかを示します。

追加された支払い先
folder.payeeAddedd boolean

支払い先が追加されたかどうかを示します。

Self-Signing 有効
folder.selfSignerEnabled boolean

セルフ署名モードが有効かどうかを示します。

[公証人が有効]
folder.notaryEnabled boolean

公証人署名が有効かどうかを示します。

制限付き可視性
folder.limitedVisibilityFlag boolean

このエンベロープの表示が制限されているかどうかを示します。

署名後の可視性
folder.postSigningVisibility boolean

署名後の可視性が有効かどうかを示します。

Wet Signature
folder.wetSignatureEnabled boolean

ウェット署名が有効かどうかを示します。

マージが有効
folder.mergeEnabled boolean

ドキュメントのマージが有効かどうかを示します。

埋め込み署名セッション
embeddedSigningSessions array of object

埋め込み署名セッションの一覧 。受信者ごとに 1 つ。 createEmbeddedSigningSession が true の場合にのみ存在します。

署名者の電子メール
embeddedSigningSessions.emailIdOfSigner string

この埋め込み署名セッションの受信者の電子メール アドレス。

署名トークン
embeddedSigningSessions.embeddedToken string

この受信者の埋め込み署名セッションの一意のトークン。

署名セッション URL
embeddedSigningSessions.embeddedSessionURL string

この受信者がドキュメントに署名するために開くか埋め込む URL。

埋め込み送信トークン
embeddedToken string

埋め込み送信セッションのトークン。 createEmbeddedSendingSession が true の場合にのみ存在します。

セッション URL の送信
embeddedSessionURL string

封筒作成者が封筒を準備して送信するために開くか埋め込む URL。 createEmbeddedSendingSession が true の場合にのみ存在します。

Result
result string

操作の結果。

Message
message string

操作の結果を説明するメッセージ。

URL からテンプレートを作成する

パブリックにアクセスできる PDF URL を使用して新しいテンプレートを作成します。

パラメーター

名前 キー 必須 説明
テンプレート名
templateName True string

テンプレートの名前。 .pdf 拡張子で終わる必要があります (例: onboarding.pdf)。

テンプレート URL
templateUrl True string

テンプレートとして使用する PDF ドキュメントのパブリックにアクセスできる URL。

入力の種類
inputType True string

ドキュメントの入力メソッド。 このアクションでは、常に 'url' に設定します。

テキスト タグの処理
processTextTags True boolean

有効にすると、Foxit eSign はドキュメントでテキスト タグをスキャンし、自動的に署名フィールドに変換します。

Acro フィールドの処理
processAcroFields True boolean

有効にすると、Foxit eSign はドキュメントで AcroFields をスキャンし、自動的に署名フィールドに変換します。

[すべて共有]
shareAll True boolean

このテンプレートをアカウント内のすべてのユーザーと共有します。

パーティの数
numberOfParties True integer

テンプレートにパーティーの数を追加します。 このパラメーターの値は 20 未満にする必要があります。

テーマの色
themeColor string

createEmbeddedTemplateSession のテーマを変更する色の css 値を入力します。

作成者Email
authorEmail string

このテンプレートの作成者として使用されるアカウントに、別のユーザーの電子メールを入力します。

埋め込みテンプレート セッションの作成
createEmbeddedTemplateSession boolean

true に設定すると、Foxit eSign テンプレート準備ビューを直接開く埋め込みテンプレート セッション。 テンプレート上のさまざまなフィールドをドラッグ アンド ドロップできます。

リダイレクト URL
redirectURL string

createEmbeddedTemplateSession が true の場合は、埋め込みテンプレート ビューで [保存して閉じる] をクリックした後にユーザーがリダイレクトされる、任意の Web サイト/アプリケーションのランディング ページの絶対 URL を入力できます。

送信テンプレートを非表示にする
hideSendTemplate boolean

true の場合、埋め込みテンプレート ビューの [送信] ボタンが非表示になります。

受信者のパーティを修正する
fixRecipientParties boolean

true の場合、埋め込みテンプレート ビューでは、既に追加されているエンベロープのパーティを変更できません。

フィールド
Fields object
アクセス許可
permission True string
順番
sequence True integer

1 から始まる、このパーティーの一意のシーケンス番号。 サインイン シーケンスが有効な場合の署名順序を定義します。

受信者ロール
partyRole True string

テンプレートでこのパーティに割り当てられたロール。

その他のアクションを非表示にする
hideMoreAction boolean

true の場合、テンプレート セッションの [その他のアクション] ボタンが非表示になります。

[すべて共有] を非表示にする
hideShareWithAll boolean

true の場合、テンプレート セッションで [すべて共有] オプションが非表示になります。

パーティーの追加を非表示にする
hideAddParty boolean

true の場合、埋め込みテンプレート セッションのすべての追加パーティのオプションが非表示になります。

[非表示] ボタン
hideMeButton boolean

true の場合、埋め込みテンプレート セッションの受信者パーティの [自分] ボタンが非表示になります。

[他のユーザーを非表示にする] ボタン
hideOthersButton boolean

true の場合、埋め込みテンプレート セッションの受信者パーティの [その他] ボタンが非表示になります。

既存の連絡先の選択オプションを非表示にする
hideExistingContactSelectOption boolean

true の場合、埋め込みテンプレート セッションの受信者の [既存の連絡先の検索と追加] 入力ボックスが非表示になります。

受信者のフィールド名を非表示にする
hideFieldNameForRecipients boolean

データ入力フィールドと高度なフィールドの受信者のフィールド名を非表示にします。(オプション ボタン、チェックボックス、イメージ、ハイパーリンクを除く)。

チェック ボックスの罫線を非表示にする
hideCheckboxBorder boolean

チェック ボックスの罫線は、実行されたドキュメントでは非表示になります。

返品

名前 パス 説明
Result
result string

操作が成功したかどうかを示します (例: 'success')。

Message
message string

操作の結果の説明。

ID
template.templateId integer

作成されたテンプレートの一意の ID。 これを使用して、このテンプレートから封筒を作成します。

名前
template.templateName string

テンプレートの名前。

Description
template.templateDesc string

テンプレートの説明。

タイプ
template.templateType string

テンプレートの種類。

[作成日付]
template.templateCreationDate string

テンプレートが作成された日付。

最終更新日
template.templateLastUpdateDate string

テンプレートが最後に更新された日付。

編集可能
template.editable boolean

テンプレートを編集できるかどうかを示します。

パーティの数
template.numberOfParties integer

テンプレートで定義されている受信者の数。

合計ページ数
template.totalPages integer

テンプレート ドキュメント内のページの合計数。

会社 ID
template.companyId integer

このテンプレートが属する会社の ID。

すべて共有
template.shareAll boolean

このテンプレートがアカウント内のすべてのユーザーと共有されているかどうかを示します。

カスタム名パターン
template.templateCustomName string

このテンプレートから作成されたエンベロープに適用されるカスタム名パターン。

パーティのアクセス許可
template.templatePartyPermissions array of object

このテンプレートで定義されている受信者ロールとそのアクセス許可の一覧。

関係者 ID
template.templatePartyPermissions.template_party_id integer

このテンプレート パーティ エントリの一意の ID。

ID
template.templatePartyPermissions.templateId integer

このパーティが属するテンプレートの ID。

Permissions
template.templatePartyPermissions.templatePermissions string

このパーティの署名アクセス許可 (例: FILL_FIELDS_AND_SIGN)。

署名順序
template.templatePartyPermissions.partySequence integer

このパーティの署名注文の位置。

パーティー ロール
template.templatePartyPermissions.templatePartyRole string

テンプレートでこのパーティに割り当てられたロール名。 テンプレートからエンベロープを作成するときに使用します。

関係者 ID
template.templatePartyPermissions.partyId integer

このロールに割り当てられているパーティの ID (事前割り当て済みの場合)。

ユーザーID
template.templateCreatedBy.partyId integer

ユーザーの一意の ID。

名前
template.templateCreatedBy.firstName string

ユーザーの名。

template.templateCreatedBy.lastName string

ユーザーの姓。

Email
template.templateCreatedBy.emailId string

ユーザーの電子メール アドレス。

会社 ID
template.templateCreatedBy.companyId integer

ユーザーが属している会社の ID。

ユーザー ロール
template.templateCreatedBy.userRole string

組織内でのユーザーの役割。

アクティブ
template.templateCreatedBy.active boolean

ユーザーのアカウントがアクティブかどうかを示します。

ユーザーID
template.templateLastUpdatedBy.partyId integer

ユーザーの一意の ID。

名前
template.templateLastUpdatedBy.firstName string

ユーザーの名。

template.templateLastUpdatedBy.lastName string

ユーザーの姓。

Email
template.templateLastUpdatedBy.emailId string

ユーザーの電子メール アドレス。

会社 ID
template.templateLastUpdatedBy.companyId integer

ユーザーが属している会社の ID。

ユーザー ロール
template.templateLastUpdatedBy.userRole string

組織内でのユーザーの役割。

アクティブ
template.templateLastUpdatedBy.active boolean

ユーザーのアカウントがアクティブかどうかを示します。

テンプレート フィールド
allfields array of object

テンプレートで定義されているすべての署名フィールドとフォーム フィールドの一覧。

フィールド ID
allfields.fieldTagId integer

フィールドの一意識別子。

テンプレート識別子
allfields.templateId integer

このフィールドが属するテンプレートの ID。

会社 ID
allfields.companyId integer

このフィールドが属する会社アカウント。

フィールドの型
allfields.fieldType string

フィールドの型 (例: signfield、initialfield、textfield、datefield、checkboxfield、securedfield、attachmentfield)。

ページ番号
allfields.documentPageNumber integer

このフィールドが配置されているドキュメントのページ番号。

責任当事者
allfields.partyResponsible integer

このフィールドの入力を担当するパーティ シーケンス番号。

パーティー シーケンス
allfields.partyResponsibleSequence integer

責任者の順序の位置。

フィールド ドキュメント ID
allfields.docFieldId string

このフィールドのドキュメント レベルの識別子。

依存している
allfields.dependent boolean

このフィールドの表示が別のフィールドの値に依存するかどうかを示します。

タブ オーダー
allfields.tabOrder integer

フィールド間を移動するためのタブ オーダー。

必須
allfields.required boolean

ドキュメントに署名する前に、このフィールドを入力する必要があるかどうかを示します。

ユーザー設定フィールド名
allfields.customFieldName string

このフィールドに割り当てられたカスタム名。

[すべて共有]
allfields.shareAll boolean

このフィールドがすべてのユーザーと共有されているかどうかを示します。

編集を許可する
allfields.allowEdit boolean

このフィールドを受信者が編集できるかどうかを示します。

テキスト フィールド名
allfields.textfieldName string

テキスト フィールドのラベル (fieldType が 'textfield' の場合に適用されます)。

価値
allfields.value string

フィールドの入力済みまたは入力済みの値。

フォント サイズ
allfields.fontSize integer

このフィールドのテキストに使用されるフォント サイズ。

フォントの色
allfields.fontColor string

このフィールドのテキストに使用されるフォントの色 (#000000 など)。

[読み取り専用]
allfields.readOnly boolean

フィールドが読み取り専用で、受信者が編集できないかどうかを示します。

複数行
allfields.multiLine boolean

テキスト フィールドが複数行の入力を受け入れるかどうかを示します (fieldType が 'textfield' の場合に適用されます)。

文字数制限
allfields.characterLimit integer

フィールドで使用できる最大文字数 (fieldType が 'textfield' の場合に適用されます)。

日付フィールド名
allfields.datefieldName string

日付フィールドのラベル (fieldType が 'datefield' の場合に適用されます)。

日付形式
allfields.dateFormat string

このフィールドで使用される日付形式 (MM/DD/YYYY など) (fieldType が 'datefield' の場合に適用されます)。

チェックボックス名
allfields.cbname string

チェックボックス フィールドのラベル (fieldType が 'checkboxfield' の場合に適用されます)。

チェックボックス グループ
allfields.cbgroup string

このチェック ボックスのグループ名 (fieldType が 'checkboxfield' の場合に適用されます)。

確認済み
allfields.checked boolean

チェック ボックスが既定でオンになっているかどうかを示します (fieldType が 'checkboxfield' の場合に適用されます)。

セキュリティで保護されたフィールド名
allfields.securedfieldName string

セキュリティで保護されたフィールドのラベル (fieldType が 'securedfield' の場合に適用されます)。

表示する文字
allfields.charToDisplay integer

セキュリティで保護されたフィールド値の末尾に表示するマスクされていない文字の数 (fieldType が 'securedfield' の場合に適用されます)。

署名 ID
allfields.signatureId string

この署名フィールドに適用される署名の ID (fieldType が 'signfield' の場合に適用されます)。

初期イメージ
allfields.initialImage string

このフィールドに適用されるイニシャルの画像データ (fieldType が 'initialfield' の場合に適用されます)。

添付ファイル フィールド名
allfields.attachmentfieldName string

添付ファイル フィールドの名前 (fieldType が 'attachmentfield' の場合に適用されます)。

添付ファイルの説明
allfields.attachmentfieldDescription string

添付する内容の説明 (fieldType が 'attachmentfield' の場合に適用されます)。

Webhook チャネルの詳細を取得する

特定の Webhook チャネルの詳細を取得します。

パラメーター

名前 キー 必須 説明
チャネル ID
channelId True string

取得する Webhook チャネルの一意識別子。

返品

名前 パス 説明
Result
result string

要求が成功したかどうかを示します。

ID
channel.channelId integer

Webhook チャネルの一意識別子。

会社 ID
channel.companyId integer

このチャネルが属する会社アカウント。

名前
channel.channelName string

Webhook チャネルの名前。

ウェブフックURL
channel.webhookUrl string

サブスクライブされたイベントが発生したときに Foxit eSign が呼び出す URL。

Webhook シークレット
channel.webhookSecret string

Webhook ペイロードの検証に使用されるシークレット キー。

作成日
channel.dateCreated integer

チャネルが作成された日付 (Unix ミリ秒)。

更新日
channel.dateUpdated integer

チャネルが最後に更新された日付 (Unix ミリ秒)。

Webhook レベル
channel.webhookLevel string

Webhook チャネルのスコープ。 "Account" (すべてのエンベロープのトリガー) または "API アプリ" (API 経由で作成されたエンベロープに対してのみトリガー) のいずれか。

地位
channel.status string

チャネルの現在の状態。 'active' または 'deactive' のいずれか。

封筒の送信
channel.eventsSubscribedMap.folder_sent boolean

封筒が受信者に送信されたときにトリガーされます。

表示された封筒
channel.eventsSubscribedMap.folder_viewed boolean

受信者が封筒を開いたときにトリガーされます。

封筒署名済み
channel.eventsSubscribedMap.folder_signed boolean

封筒が受信者によって署名されたときにトリガーされます。

封筒の取り消し
channel.eventsSubscribedMap.folder_cancelled boolean

エンベロープが取り消されたときにトリガーされます。

エンベロープ実行済み
channel.eventsSubscribedMap.folder_executed boolean

すべてのパーティが署名し、エンベロープが完全に実行されたときにトリガーされます。

封筒削除済み
channel.eventsSubscribedMap.folder_deleted boolean

エンベロープが削除されたときにトリガーされます。

Webhook トリガーの登録を解除する

アクティブな Webhook チャネル サブスクリプションをチャネル ID で削除します。 このアクションを使用して、不要になった Webhook サブスクリプションをクリーンアップします。

パラメーター

名前 キー 必須 説明
チャネル ID
channelId True integer

削除する Webhook チャネルの ID。

すべての Webhook チャネルを一覧表示する

アカウントで構成されているすべての Webhook チャネルの一覧を返します。

返品

名前 パス 説明
Result
result string

要求が成功したかどうかを示します。

合計チャネル数
total_channel integer

アカウントで構成された Webhook チャネルの合計数。

Webhook チャネル
templatesList array of object

アカウント内のすべての Webhook チャネルの一覧。

チャネル ID
templatesList.channelId integer

Webhook チャネルの一意識別子。

会社 ID
templatesList.companyId integer

このチャネルが属する会社アカウント。

チャネル名
templatesList.channelName string

Webhook チャネルの名前。

ウェブフックURL
templatesList.webhookUrl string

サブスクライブされたイベントが発生したときに Foxit eSign が呼び出す URL。

Webhook シークレット
templatesList.webhookSecret string

Webhook ペイロードの検証に使用されるシークレット キー。

作成日
templatesList.dateCreated integer

チャネルが作成された日付 (Unix ミリ秒)。

更新日
templatesList.dateUpdated integer

チャネルが最後に更新された日付 (Unix ミリ秒)。

Webhook レベル
templatesList.webhookLevel string

Webhook チャネルのスコープ。 "Account" (すべてのエンベロープのトリガー) または "API アプリ" (API 経由で作成されたエンベロープに対してのみトリガー) のいずれか。

地位
templatesList.status string

チャネルの現在の状態。 'active' または 'deactive' のいずれか。

封筒の送信
templatesList.eventsSubscribedMap.folder_sent boolean

封筒が受信者に送信されたときにトリガーされます。

表示された封筒
templatesList.eventsSubscribedMap.folder_viewed boolean

受信者が封筒を開いたときにトリガーされます。

封筒署名済み
templatesList.eventsSubscribedMap.folder_signed boolean

封筒が受信者によって署名されたときにトリガーされます。

封筒の取り消し
templatesList.eventsSubscribedMap.folder_cancelled boolean

エンベロープが取り消されたときにトリガーされます。

エンベロープ実行済み
templatesList.eventsSubscribedMap.folder_executed boolean

すべてのパーティが署名し、エンベロープが完全に実行されたときにトリガーされます。

封筒削除済み
templatesList.eventsSubscribedMap.folder_deleted boolean

エンベロープが削除されたときにトリガーされます。

すべてのテンプレートの一覧を取得する

アカウントで使用可能なすべてのテンプレートの一覧を返します。

返品

名前 パス 説明
Result
result string

要求が成功したかどうかを示します。

合計テンプレート数
total_templates integer

アカウント内のテンプレートの合計数。

テンプレートの一覧
templatesList array of object

アカウントで使用可能なすべてのテンプレートの一覧。

テンプレート識別子
templatesList.templateId integer

テンプレートの一意識別子。 署名用のテンプレートを送信するには、この ID とテンプレートからのエンベロープの作成を使用します。

テンプレート名
templatesList.templateName string

テンプレートの名前。

テンプレートの説明
templatesList.templateDesc string

テンプレートの説明。

テンプレートの種類
templatesList.templateType string

テンプレートの種類またはカテゴリ。

作成日
templatesList.templateCreationDate integer

テンプレートが作成された日付 (Unix ミリ秒)。

最終更新日
templatesList.templateLastUpdateDate integer

テンプレートが最後に更新された日付 (Unix ミリ秒)。

編集可能
templatesList.editable boolean

テンプレートを編集できるかどうかを示します。

パーティの数
templatesList.numberOfParties integer

テンプレートで定義されている署名者の数。

会社 ID
templatesList.companyId integer

テンプレートが属する会社アカウント。

[すべてと共有]
templatesList.shareAll boolean

テンプレートがアカウント内のすべてのユーザーと共有されているかどうかを示します。

関係者 ID
templatesList.templateCreatedBy.partyId integer

ユーザーに固有の識別子。

名前
templatesList.templateCreatedBy.firstName string

ユーザーの名。

templatesList.templateCreatedBy.lastName string

ユーザーの姓。

Email
templatesList.templateCreatedBy.emailId string

ユーザーの電子メール アドレス。

関係者 ID
templatesList.templateLastUpdatedBy.partyId integer

ユーザーに固有の識別子。

名前
templatesList.templateLastUpdatedBy.firstName string

ユーザーの名。

templatesList.templateLastUpdatedBy.lastName string

ユーザーの姓。

Email
templatesList.templateLastUpdatedBy.emailId string

ユーザーの電子メール アドレス。

エンベロープ ID を取得する

状態でフィルター処理された封筒 ID の一覧を返します。 これを使用して、特定の状態の封筒を検索します。

パラメーター

名前 キー 必須 説明
開始日
dateFrom True string

封筒作成の日付範囲の開始。 使用できる形式: YYYY-MM-DD。

日付の終了日
dateTo True string

封筒作成の日付範囲の末尾。 使用できる形式: YYYY-MM-DD。 dateTo 値は、dateFrom 値の 6 か月以内である必要があります。

地位
status string

封筒を状態でフィルター処理します。 指定できる値: EXECUTED、SHARED、DRAFT、PARTIALLY SIGNED、CANCELLED、EXPIRED、DELETED。 省略すると、任意の状態の封筒が返されます。

返品

名前 パス 説明
Result
result string

要求が成功したかどうかを示します。

Message
message string

返されたエンベロープ ID の数を示す概要メッセージ。

エンベロープ ID
allFolderIds array of integer

フィルター条件に一致するエンベロープ ID の一覧。 これらの ID を Get Envelope Details と共に使用して、完全なエンベロープ情報を取得します。

エンベロープ アクティビティ履歴を取得する

受信者と送信者が実行したすべてのアクションを示す、エンベロープの完全なアクティビティ ログを取得します。

パラメーター

名前 キー 必須 説明
封筒 ID
folderId True integer

アクティビティ履歴を取得するエンベロープの一意識別子。

返品

名前 パス 説明
Result
result string

要求が成功したかどうかを示します。

封筒 ID
details.folderId integer

封筒の一意識別子。

囲まれたドキュメント
details.enclosedDocuments string

封筒で囲まれた文書の名前。

受取人
details.envelopeRecipients string

封筒のすべての受信者の名前。

Author
details.author string

封筒を作成したユーザーの名前。

地位
details.status string

エンベロープの現在の状態 (SHARED、EXECUTED、CANCELLED など)。

最新のアクティビティの日付
details.latestActivityDate string

封筒の最新のアクティビティの日付と時刻。

作成日
details.dateCreated string

封筒が作成された日時。

送信日
details.dateSent string

封筒が受信者に送信された日時。

アクティビティ
details.activities array of object

このエンベロープで実行されたすべてのアクションの時系列リスト。

Activity
details.activities.activity string

発生したアクションの人間が判読できる説明。

Action
details.activities.action string

実行されたアクションの種類 (例: Created、Invitation Sent、Opened、Viewed、Signed)。

ユーザー
details.activities.user string

アクションを実行したユーザーの名前。

封筒の状態
details.activities.folderStatus string

このアクションが発生した時点のエンベロープの状態。

時間
details.activities.time string

アクションが発生した日時。

Source
details.activities.source string

アクションが実行されたソース (Web など)。

IP アドレス
details.activities.ipAddress string

アクションが実行された IP アドレス (使用可能な場合)。

テンプレート ID でテンプレートを取得する

1 つ以上のテンプレートの詳細を ID で取得します。

パラメーター

名前 キー 必須 説明
テンプレート ID
templateIds True array of integer

取得するテンプレート ID の配列。

返品

名前 パス 説明
Result
result string

要求が成功したかどうかを示します。

合計テンプレート数
total_templates integer

返されたテンプレートの合計数。

テンプレート リスト
templateIdList object

テンプレート ID でキー指定されたテンプレート データのマップ。 各エントリには、テンプレートの詳細とそのフィールドが含まれています。

テンプレートから封筒を作成する

既存のテンプレートを使用して封筒を作成して送信します。 受信者の詳細はカスタマイズできます。

パラメーター

名前 キー 必須 説明
封筒名
folderName string

ドキュメント フォルダーの名前。 この値を指定しない場合、ドキュメントのフォルダー名はテンプレート名と同じになります。

テンプレート ID
templateIds True array of integer

このフォルダーのドキュメントを作成するために使用するテンプレート ID の配列。

フィールド
fields object

テンプレートで使用されるフィールド値を渡して、テンプレートから作成されたドキュメントに事前入力することができます。 FIELD_NAMEは、テンプレートで使用されるフィールドの名前です。 FIELD_VALUEはドキュメント フィールドの値です。

高度な電子メール検証
allowAdvancedEmailValidation boolean

true に設定されている場合は、パーティのメール アドレスを検証します。

名前
firstName True string

受信者の名。

lastName True string

受信者の姓。

Emailアドレス
emailId True string

受信者のメール アドレス。

アクセス許可
permission True string
順番
sequence True integer

このフィールドを使用して、受信者のリスト内の受信者にシーケンス番号を割り当てます。 1、2、3、4 など、1 から始まる各パーティに一意のシーケンス番号を使用します。署名ワークフローに 1 人のユーザーが複数回表示される場合は、受信者が繰り返されるたびに異なるシーケンスを割り当ててください。

signerAuthLevels
signerAuthLevel string

署名者が検証のために利用する認証のレベル

プレースホルダー
isPlaceholder boolean

このフィールドを使用して、パーティがプレースホルダーであることを開始します。 注: 1。 firstName、lastName、emailId パラメーターの値は、このパーティの空白にする必要があります。 2. プレースホルダーを追加するには、1 人の受信者を 'PARTY_ASSIGNER' アクセス許可で再実行する必要があります。

受信者ロール
partyRole string

このフィールドを使用して、プレースホルダーのロールを割り当てます。

名前の変更を許可する
allowNameChange string

値には true または false を指定できます。署名プロセスを完了する前に、署名者が姓と名を更新できるようにするには、このパラメーターを使用します。

ワークフロー シーケンス
workflowSequence integer

この受信者にワークフロー シーケンス番号を割り当てます。 サインイン シーケンスが有効になっている場合、受信者は昇順で署名の招待を受け取ります。

ホスト電子メール ID
hostEmailId string

In-Person 管理者の電子メール アドレス。

アクセス コード
userDefinedAccessCode string

認証用に "signerAuthLevel" 値が "ユーザー定義アクセス コード" として設定されている場合、パラメーターには Access Code が含まれます。 注: 1。 コードでは大文字と小文字は区別されません。 2. システムはこのコードを送信しないため、署名者と直接このコードを共有する必要があります。 3. アクセス コードには、アルファベット、数字、および次の特殊文字を含めることができます: @、&{,}、%、(、~、|,!,+、^)。

パーティーは電子メール グループです
partyIsEmailGroup boolean

パーティーを一括で作成する場合は、このパラメーターを使用します。 メモ: このパラメーターが true の場合、このパーティの firstName、lastName、emailId は無視されます。

電子メール グループ ID
emailGroupId integer

一括作成に使用するグループ ID を電子メールで渡します。

シングル 署名者の一括
allowSingleSignerInBulk boolean

このパラメーターを使用して、1 人のユーザーのみが電子メール グループにサインインできるようにします。

ダイヤル コード
dialingCode string

このフィールドを使用して、受信者のリスト内の受信者に携帯電話番号プレフィックスである国のダイヤルイン コードを割り当てます。

携帯電話番号
mobileNumber string

このフィールドを使用して、受信者の一覧で受信者に携帯電話番号を割り当てます。

封筒のパスワード
folderPassword string

このパスワードは、デジタル署名されたドキュメントを開くために署名者/作成者が必要とします。 パラメーターを空白のままにした場合、デジタル署名されたドキュメントを開くためにパスワードは必要ありません。

サインイン シーケンス
signInSequence boolean

このフィールドは、受信者が順番に封筒ドキュメントに署名するかどうかを決定するために使用されます。 false の場合、すべての受信者が同時に招待メールを受信します。 true の場合、各受信者は、前の受信者が必要なタスク (ドキュメントへの署名やフィールドの入力など) を完了した後、連続して招待メールを受信します。

In Person Enable
inPersonEnable boolean

このフィールドは、任意のデバイスで数分で簡単に完了できる直接署名プロセスを開始するために使用され、必要に応じて電子メール ベースの署名を回避します。 false の場合、すべての受信者は同時に招待メールを受信します。 true の場合、直接管理者は署名者の署名プロセスを開始するための招待メールを受け取ります。

今すぐ送信
sendNow boolean

有効にすると、Foxit eSign は直ちに一意の署名リンクを各受信者のメール アドレスに送信します。 封筒を下書きとして保存するには、これを無効にします。

Sign Success Url All Parties
signSuccessUrlAllParties boolean

true に設定すると、署名に成功した後、署名者は signSuccessUrl で指定された URL にリダイレクトされます。 これは、sendNow が true の場合にのみ適用されます。

埋め込み送信セッションを作成する
createEmbeddedSendingSession boolean

true に設定すると、埋め込み URL が生成され、Foxit eSign のドキュメント準備ビューが開きます。

受信者のパーティを修正する
fixRecipientParties boolean

true の場合、埋め込み送信ビューでは、この要求の一部として既に追加されているエンベロープのパーティを変更できません。

ドキュメントの修正
fixDocuments boolean

true の場合、埋め込み送信では、この要求の一部として既に追加されている封筒のドキュメントを変更できません。

成功 URL の送信
sendSuccessUrl string

埋め込み送信ビューでフォルダーを正常に送信した後に署名者がリダイレクトされるランディング ページの絶対 URL を入力します。

エラー URL の送信
sendErrorUrl string

埋め込み送信ビューでのフォルダーの送信中にエラーが発生した場合に署名者がリダイレクトされるランディング ページの絶対 URL を入力します。

署名者の選択オプションを非表示にする
hideSignerSelectOption boolean

true の場合、埋め込み送信セッションの受信者の [既存の署名者名/電子メール] 入力ボックスが非表示になります。

署名者アクションを非表示にする
hideSignerActions boolean

true の場合、埋め込み送信セッションの受信者に対する署名者の "編集"、"変更"、"削除" アクションが非表示になります。

送信者名を非表示にする
hideSenderName boolean

true の場合、埋め込み送信セッションの受信者パーティの送信者名が非表示になります。

送信ボタンを非表示にする
hideSendButton boolean

true の場合、埋め込み送信セッションの [送信] ボタンが非表示になります。

フォルダー名を非表示にする
hideFolderName boolean

true の場合、両方の埋め込みセッションのナビゲーションでフォルダー名が非表示になります。

ドキュメント名を非表示にする
hideDocumentsName boolean

true の場合、両方の埋め込みセッションでドキュメント名が非表示になります。

[自分の追加] ボタンを非表示にする
hideAddMeButton boolean

true の場合、埋め込み送信セッションの受信者の [自分の追加] ボタンが非表示になります。

[新しい追加] ボタンを非表示にする
hideAddNewButton boolean

true の場合、埋め込み送信セッションの受信者パーティの [新規追加] ボタンが非表示になります。

[グループの追加] ボタンを非表示にする
hideAddGroupButton boolean

true の場合、埋め込み送信セッションの受信者パーティの [グループの追加] ボタンが非表示になります。

埋め込み署名セッションの作成
createEmbeddedSigningSession boolean

署名セッション トークンは、受信者に電子メールを送信せずに生成されます。

すべてのパーティの埋め込み署名セッションを作成する
createEmbeddedSigningSessionForAllParties boolean

true に設定すると、エンベロープ内のすべての受信者に対して埋め込み署名 URL が生成されます。 false の場合、埋め込み署名者の電子メール ID に記載されている受信者のみが埋め込みセッションを受信します。

埋め込み署名者の電子メール ID
embeddedSignersEmailIds array of string

埋め込み署名セッションを作成する必要がある受信者の電子メール ID の配列。 パーティの一覧に追加された受信者の電子メール ID。

成功 URL に署名する
signSuccessUrl string

埋め込み署名ビューに正常にサインインした後にリダイレクトされる署名者の絶対 URL を入力します。

辞退 URL に署名する
signDeclineUrl string

埋め込み署名ビューへのサインインを拒否した場合にリダイレクトされる署名者の絶対 URL を入力します。

後で URL に署名する
signLaterUrl string

埋め込み署名ビューで後でサインインすることを選択した場合にリダイレクトされる署名者の絶対 URL を入力します。

エラー URL に署名する
signErrorUrl string

埋め込み署名ビューでドキュメントの署名中にエラーが発生した場合にリダイレクトされる署名者の絶対 URL を入力します。

次の必須フィールド Btn を非表示にする
hideNextRequiredFieldBtn boolean

true に設定すると、署名者を次の必須フィールドに移動するナビゲーション ボタンが非表示になります。

テーマの色
themeColor string

CSS 値を入力してテーマの色を設定します。

署名の拒否を非表示にする
hideDeclineToSign boolean

true に設定すると、署名画面の [署名の拒否] オプションが非表示になります。

その他のアクションを非表示にする
hideMoreAction boolean

true に設定すると、送信および署名セッションの [その他のアクション] ボタンが非表示になります。 [今すぐ送信] が true の場合は効果がありません。

[パーティーの追加] オプションを非表示にする
hideAddPartiesOption boolean

true に設定すると、下書きモードとテンプレート作成モードでパーティーを追加するオプションが非表示になります。

セッションの有効期限
sessionExpire boolean

埋め込み署名セッションの有効期限を開始するには、true に設定します。

有効期限
expiry integer

sessionExpire が true の場合は必須。 埋め込み署名セッションの有効期限のミリ秒単位の期間を入力します。

送信者の電子メール
senderEmail string

このドキュメント フォルダーを受信者に送信するために使用する、アカウント内の別のユーザーの電子メールを入力します。

今すぐ送信と埋め込み署名セッションを許可する
allowSendNowAndEmbeddedSigningSession boolean

true に設定すると、Foxit eSign は各受信者に署名招待メールを送信し、埋め込み署名者の電子メールに電子メールが含まれている受信者の埋め込み署名リンクも生成します。 電子メールと埋め込みリンクの両方が同時にアクティブになります。

ステップ バイ ステップを有効にする
enableStepByStep boolean

埋め込み送信セッションでステップ バイ ステップ アクションを有効にする。

返品

名前 パス 説明
Result
result string

操作が成功したかどうかを示します (例: 'success')。

Message
message string

操作の結果の説明。

埋め込み署名セッション
embeddedSigningSessions array of object

埋め込み署名セッションの一覧 。受信者ごとに 1 つ。 createEmbeddedSigningSession が true の場合にのみ存在します。

署名者の電子メール
embeddedSigningSessions.emailIdOfSigner string

この埋め込み署名セッションの受信者の電子メール アドレス。

署名トークン
embeddedSigningSessions.embeddedToken string

この受信者の埋め込み署名セッションの一意のトークン。

署名セッション URL
embeddedSigningSessions.embeddedSessionURL string

この受信者がドキュメントに署名するために開くか埋め込む URL。

埋め込み送信トークン
embeddedToken string

埋め込み送信セッションのトークン。 createEmbeddedSendingSession が true の場合にのみ存在します。

セッション URL の送信
embeddedSessionURL string

封筒作成者が封筒を準備して送信するために開くか埋め込む URL。 createEmbeddedSendingSession が true の場合にのみ存在します。

ID
folder.folderId integer

作成された封筒の一意の ID。 これを使用して、後続のアクションでエンベロープを参照します。

名前
folder.folderName string

封筒の名前。

カスタム名
folder.folderCustomName string

封筒に割り当てられたカスタム名。

パスワード
folder.folderPassword string

封筒に設定されたパスワード (存在する場合)。

作成者 ID
folder.folderAuthorId integer

エンベロープを作成したユーザーの一意の ID。

作成者名
folder.folderAuthorFirstName string

封筒作成者の名。

作成者の姓
folder.folderAuthorLastName string

封筒作成者の姓。

作成者Email
folder.folderAuthorEmail string

封筒作成者のメール アドレス。

作成者ロール
folder.folderAuthorRole string

エンベロープ作成者のアカウント ロール。

会社 ID
folder.folderCompanyId integer

封筒が属する会社の一意の ID。

[作成日付]
folder.folderCreationDate integer

エンベロープが作成された日付と時刻 (Unix ミリ秒)。

送信日
folder.folderSentDate integer

封筒が受信者に送信された日付と時刻 (Unix ミリ秒)。

地位
folder.folderStatus string

エンベロープの現在の状態 (SHARED、EXECUTED、DRAFT、CANCELLED など)。

ユーザー設定フィールド 1
folder.custom_field1 string

封筒に設定されたユーザー設定フィールド 1 の値。

ユーザー設定フィールド 2
folder.custom_field2 string

封筒に設定されたユーザー設定フィールド 2 の値。

Metadata
folder.metadata string

エンベロープに関連付けられている追加のメタデータ。

ドキュメント ID
folder.folderDocumentIds array of integer

この封筒に含まれるドキュメント ID の一覧。

ドキュメント​
folder.documentsList array of object

封筒に含まれる各ドキュメントの詳細。

ドキュメント ID
folder.documentsList.documentId integer

ドキュメントの一意識別子。

コントラクト ID
folder.documentsList.contractId integer

このドキュメントに関連付けられているコントラクトの一意識別子。

会社 ID
folder.documentsList.companyId integer

このドキュメントが属する会社の一意の ID。

作成者
folder.documentsList.contractCreatedBy integer

コントラクトを作成したユーザーのユーザー ID。

作成日
folder.documentsList.contractCreatedOn string

コントラクトが作成された日付。

コントラクトの種類
folder.documentsList.contractType string

コントラクトの型。

ドキュメントの状態
folder.documentsList.contractStatus string

ドキュメントの現在の署名状態 (例: WAITING_FOR_SIGNATURE、EXECUTED)。

編集可能
folder.documentsList.editable boolean

ドキュメントを編集できるかどうかを示します。

バージョン ID
folder.documentsList.contractVersionId integer

現在のドキュメント バージョンの一意の ID。

バージョン名
folder.documentsList.contractVersionName string

現在のドキュメント バージョンの名前。

バージョンの説明
folder.documentsList.contractVersionDesc string

現在のドキュメント バージョンの説明。

作成者のバージョン
folder.documentsList.versionCreatedby integer

このドキュメント バージョンを作成したユーザーのユーザー ID。

作成日のバージョン
folder.documentsList.versionCreatedOn string

このドキュメント バージョンが作成された日付。

バージョン番号
folder.documentsList.contractVersionNumber integer

ドキュメントのバージョン番号。

トランザクション ソース
folder.documentsList.contractTransactionSource string

コントラクト トランザクションのソース。

受取人
folder.folderRecipientParties array of object

個々の署名リンクを含む、この封筒の受信者の一覧。

受信者 ID
folder.folderRecipientParties.partyId integer

受信者の一意識別子。

受信者 ID
folder.folderRecipientParties.partyDetails.partyId integer

受信者の一意識別子。

名前
folder.folderRecipientParties.partyDetails.firstName string

受信者の名前。

folder.folderRecipientParties.partyDetails.lastName string

受信者の姓。

Email
folder.folderRecipientParties.partyDetails.emailId string

受信者の電子メール アドレス。

プレースホルダー
folder.folderRecipientParties.partyDetails.placeholder boolean

この受信者がプレースホルダーであるかどうかを示します。

住所
folder.folderRecipientParties.partyDetails.address string

受信者のアドレス。

アカウントの作成日
folder.folderRecipientParties.partyDetails.dateCreated integer

受信者のアカウントが作成された日付 (Unix ミリ秒)。

電子メールをオプトアウトする
folder.folderRecipientParties.partyDetails.optOutEmails boolean

受信者が電子メール通知をオプトアウトしたかどうかを示します。

一意のパーティー ID
folder.folderRecipientParties.partyDetails.uniquePartyId string

受信者の一意の文字列識別子。

認証レベル
folder.folderRecipientParties.partyDetails.authenticationLevel string

この受信者に必要な認証レベル。

会社 ID
folder.folderRecipientParties.partyDetails.companyId integer

受信者が属している会社の ID。

ユーザー ロール
folder.folderRecipientParties.partyDetails.userRole string

組織内の受信者の役割。

部門
folder.folderRecipientParties.partyDetails.department string

受信者の部署。

Title
folder.folderRecipientParties.partyDetails.title string

受信者の役職。

アクティブ
folder.folderRecipientParties.partyDetails.active boolean

受信者のアカウントがアクティブかどうかを示します。

ダイヤル コード
folder.folderRecipientParties.partyDetails.dialingCode string

受信者の電話番号の国のダイヤル コード。

携帯電話番号
folder.folderRecipientParties.partyDetails.mobileNumber string

受信者の携帯電話番号。

協力会社の説明
folder.folderRecipientParties.partyDetails.subcontractorDescription string

該当する場合は、下請け業者の説明。

協力会社組織
folder.folderRecipientParties.partyDetails.subcontractorOrganization string

該当する場合は、下請け業者の組織名。

協力会社の追加日
folder.folderRecipientParties.partyDetails.subcAddedDate integer

下請け業者が追加された日付 (Unix ミリ秒)。

Source
folder.folderRecipientParties.partyDetails.source string

受信者が追加されたソース。

ダイヤル コード
folder.folderRecipientParties.dialingCode string

受信者の携帯電話番号の国ダイヤル コード。

携帯電話番号
folder.folderRecipientParties.mobileNumber string

受信者の携帯電話番号。

署名の種類
folder.folderRecipientParties.signerSignatureType string

この受信者に許可される署名の種類。

Permissions
folder.folderRecipientParties.contractPermissions string

この受信者に付与された署名アクセス許可 (例: FILL_FIELDS_AND_SIGN)。

署名順序
folder.folderRecipientParties.partySequence integer

署名順序でのこの受信者の位置。

ワークフロー シーケンス
folder.folderRecipientParties.workflowSignSequence integer

この受信者のワークフロー署名シーケンス番号。

封筒 ID
folder.folderRecipientParties.envelopeId integer

この受信者が属する封筒の ID。

パーティー会社 ID
folder.folderRecipientParties.partyCompanyId integer

この受信者が属している会社の ID。

共有モード
folder.folderRecipientParties.sharingMode string

この受信者とドキュメントを共有するために使用されるメソッド (電子メールなど)。

署名 URL
folder.folderRecipientParties.folderAccessURL string

この受信者の一意の署名 URL。 これを使用して、署名リンクを直接共有します。

セキュリティ モード
folder.folderRecipientParties.securityMode string

この受信者のアクセスに適用されるセキュリティ モード。

追加のコメント
folder.folderRecipientParties.extraComments string

この受信者の署名の招待に含まれる追加のコメント。

名前の変更を許可する
folder.folderRecipientParties.allowNameChange boolean

受信者が署名前に名前を変更できるかどうかを示します。

更新された名前
folder.folderRecipientParties.signerNameUpdated boolean

受信者が表示名を更新したかどうかを示します。

認証レベル
folder.folderRecipientParties.signerAuthenticationLevel string

この受信者がドキュメントにアクセスするために必要な認証方法。

アクセス コード
folder.folderRecipientParties.userDefinedAccessCode string

この受信者がドキュメントを開くために必要なカスタム アクセス コード。

署名 ID
folder.folderRecipientParties.signatureId string

この受信者が使用する保存済み署名の ID。

受信者ロール
folder.folderRecipientParties.partyRole string

封筒でこの受信者に割り当てられたロール。

会社フィールド値
folder.folderRecipientParties.companyFieldValue string

この受信者に対して事前に入力された会社フィールドの値。

タイトル フィールドの値
folder.folderRecipientParties.titleFieldValue string

この受信者のタイトル フィールドの値が事前に入力されています。

署名の理由
folder.folderRecipientParties.reasonSigning string

この受信者によって提供される署名の理由。

[支払い] フィールドが追加されました
folder.folderRecipientParties.payFieldAdded boolean

この受信者の支払フィールドが追加されたかどうかを示します。

支払い先
folder.folderRecipientParties.payee boolean

この受信者が支払者であるかどうかを示します。

定期的なフィールドが存在する
folder.folderRecipientParties.recurringFieldExist boolean

この受信者に対して定期的な支払いフィールドが存在するかどうかを示します。

印刷と署名完了
folder.folderRecipientParties.printAndSignCompleted boolean

受信者が印刷および署名アクションを完了したかどうかを示します。

省略可能な署名者を許可する
folder.folderRecipientParties.allowOptionalSigner boolean

この受信者を省略可能な署名者としてスキップできるかどうかを示します。

省略可能な署名者
folder.folderRecipientParties.optionalSigners string

この受信者に関連付けられている省略可能な署名者の一覧 (存在する場合)。

有料
folder.folderRecipientParties.paid boolean

この受信者が支払いを完了したかどうかを示します。

作成者アクセス URL
folder.folderAccessURLForAuthor string

ドキュメントにアクセスするためのエンベロープ作成者の URL。

下書きアクセス URL
folder.draftFolderAccessURL string

ドラフト状態のエンベロープにアクセスするための URL。

ボードルームサイン
folder.boardRoomSign boolean

この封筒に対してボード ルームの署名が有効かどうかを示します。

ロゴを含める
folder.includeLogo boolean

会社のロゴが電子メール通知に含まれているかどうかを示します。

メール ボタンの色
folder.email_btnBgColor string

署名メールのアクション ボタンの背景色。

電子メール ボタンのテキストの色
folder.email_btnTxtColor string

署名メールのアクション ボタンのテキストの色。

電子メール のロゴ
folder.emailTemplateLogo string

電子メール テンプレートで使用されるロゴイメージ。

電子メール テンプレート ID
folder.emailTemplateId integer

署名通知に使用される電子メール テンプレートの ID。

電子メール ヘッダー
folder.emailHeader string

署名通知メールのカスタム ヘッダー テキスト。

電子メール フッター
folder.emailFooter string

署名通知メールのカスタム フッター テキスト。

スケジュールされた消去
folder.purgeFlag boolean

このエンベロープが自動消去にスケジュールされているかどうかを示します。

消去の開始日
folder.purgeStartDate string

消去期間の開始日。

終了日を消去する
folder.purgeEndDate string

封筒が消去される日付。

一括 ID
folder.bulkId integer

このエンベロープが属する一括送信バッチの ID (存在する場合)。

署名順序を適用する
folder.enforceSignWorkflow boolean

受信者が指定した順序でサインインする必要があるかどうかを示します。

現在のワークフロー ステップ
folder.currentWorkflowStep integer

署名ワークフローの現在のステップ。

トランザクション ソース
folder.transactionSource string

このエンベロープ トランザクションを開始したソース。

編集可能
folder.editable boolean

封筒を編集できるかどうかを示します。

In-Person 署名
folder.inPersonSignable boolean

封筒を個人でサインインできるかどうかを示します。

アラームをオーバーライドする
folder.overrideAccountReminders boolean

この封筒のアカウント レベルのアラーム設定をオーバーライドするかどうかを示します。

委任のオーバーライド
folder.overrideAccountRecipientDelegation boolean

このエンベロープのアカウント レベルの委任設定をオーバーライドするかどうかを示します。

委任を許可する
folder.allowRecipientsToDelegate boolean

受信者が他のユーザーに署名を委任できるかどうかを示します。

ID
folder.envelopeId integer

封筒の一意の ID。 エンベロープ ID (folderId) と同じ値。

名前
folder.envelopeName string

封筒の名前。 封筒名 (folderName) と同じ値。

発信元 ID
folder.envelopeOriginatorId integer

封筒を作成したユーザーのユーザー ID。

会社 ID
folder.envelopeCompanyId integer

封筒が属する会社の ID。

Date
folder.envelopeDate integer

エンベロープが作成された日付と時刻 (Unix ミリ秒)。

共有日
folder.envelopeSharedDate integer

封筒が受信者と共有された日付と時刻 (Unix ミリ秒)。

地位
folder.envelopeStatus string

封筒の現在の状態。 封筒の状態 (folderStatus) と同じ値。

コントラクト ID
folder.envelopeContractIds array of integer

このエンベロープに関連付けられているコントラクト ID の一覧。

パーティのアクセス許可
folder.envelopePartyPermissions array of object

受信者とその署名アクセス許可の一覧。 受信者と同じ構造。

受信者 ID
folder.envelopePartyPermissions.partyId integer

受信者の一意識別子。

署名 URL
folder.envelopePartyPermissions.folderAccessURL string

この受信者の一意の署名 URL。

Permissions
folder.envelopePartyPermissions.contractPermissions string

この受信者の署名アクセス許可。

署名順序
folder.envelopePartyPermissions.partySequence integer

署名順序でのこの受信者の位置。

認証レベル
folder.envelopeAuthenticationLevel string

エンベロープ全体に適用される認証レベル。

シングル 署名者の一括を許可する
folder.allowSingleSignerInBulk boolean

シングル 署名者が一括送信モードで許可されるかどうかを示します。

ファイルに基づく名前
folder.folderNameBasedOnFileNaming boolean

エンベロープ名がファイル名から派生しているかどうかを示します。

ファイルに基づくドキュメント名
folder.documentNameBasedOnFileNaming boolean

ドキュメント名がファイル名から派生しているかどうかを示します。

ファイルに基づく証明書名
folder.certificateNameBasedOnFileNaming boolean

証明書名がファイル名から派生しているかどうかを示します。

ファイルの名前付けを有効にする
folder.enableFileNamingBeforeExecution boolean

封筒が送信される前にファイルの名前付けを求めるメッセージが表示されるかどうかを示します。

追加された支払い先
folder.payeeAddedd boolean

支払い先が封筒に追加されたかどうかを示します。

セルフ 署名者
folder.selfSignerEnabled boolean

差出人がこの封筒の署名者でもあるかどうかを示します。

[公証人が有効]
folder.notaryEnabled boolean

このエンベロープに対して公証が有効になっているかどうかを示します。

制限付き可視性
folder.limitedVisibilityFlag boolean

ドキュメントの表示が制限されているかどうかを示します。

署名後の可視性
folder.postSigningVisibility boolean

受信者が完了後に署名済みドキュメントを表示できるかどうかを示します。

Wet Signature Enabled
folder.wetSignatureEnabled boolean

この封筒に対してウェット (手書き) 署名が有効かどうかを示します。

マージが有効
folder.mergeEnabled boolean

この封筒に対して文書の差し込み印刷が有効かどうかを示します。

テンプレートの詳細を取得する

フィールドや受信者など、特定のテンプレートの完全な詳細を取得します。

パラメーター

名前 キー 必須 説明
テンプレート識別子
templateId True string

取得するテンプレートの一意識別子。

返品

名前 パス 説明
Result
result string

要求が成功したかどうかを示します。

ID
template.templateId integer

テンプレートの一意識別子。

名前
template.templateName string

テンプレートの名前。

Description
template.templateDesc string

テンプレートの説明。

タイプ
template.templateType string

テンプレートの種類。

作成日
template.templateCreationDate integer

テンプレートが作成された日付 (Unix ミリ秒)。

最終更新日
template.templateLastUpdateDate integer

テンプレートが最後に更新された日付 (Unix ミリ秒)。

編集可能
template.editable boolean

テンプレートを編集できるかどうかを示します。

パーティの数
template.numberOfParties integer

テンプレートで定義されている署名者の数。

合計ページ数
template.totalPages integer

テンプレート ドキュメント内のページの合計数。

会社 ID
template.companyId integer

テンプレートが属する会社アカウント。

[すべてと共有]
template.shareAll boolean

テンプレートがアカウント内のすべてのユーザーと共有されているかどうかを示します。

カスタム名パターン
template.templateCustomName string

このテンプレートから作成されたエンベロープに適用されるカスタム名パターン。

パーティのアクセス許可
template.templatePartyPermissions array of object

このテンプレートで定義されている受信者ロールとその署名アクセス許可の一覧。

関係者 ID
template.templatePartyPermissions.template_party_id integer

このテンプレート パーティ エントリの一意の ID。

ID
template.templatePartyPermissions.templateId integer

このパーティが属するテンプレートの ID。

Permissions
template.templatePartyPermissions.templatePermissions string

このパーティの署名アクセス許可 (例: FILL_FIELDS_AND_SIGN)。

署名順序
template.templatePartyPermissions.partySequence integer

このパーティの署名注文の位置。

パーティー ロール
template.templatePartyPermissions.templatePartyRole string

このパーティに割り当てられているロール名。 このテンプレートからエンベロープを作成するときは、この値を使用します。

関係者 ID
template.templatePartyPermissions.partyId integer

このロールに割り当てられているパーティの ID (事前割り当て済みの場合)。

関係者 ID
template.templateCreatedBy.partyId integer

ユーザーに固有の識別子。

名前
template.templateCreatedBy.firstName string

ユーザーの名。

template.templateCreatedBy.lastName string

ユーザーの姓。

Email
template.templateCreatedBy.emailId string

ユーザーの電子メール アドレス。

部門
template.templateCreatedBy.department string

ユーザーの部署。

Title
template.templateCreatedBy.title string

ユーザーの役職。

アクティブ
template.templateCreatedBy.active boolean

ユーザー アカウントがアクティブかどうかを示します。

関係者 ID
template.templateLastUpdatedBy.partyId integer

ユーザーに固有の識別子。

名前
template.templateLastUpdatedBy.firstName string

ユーザーの名。

template.templateLastUpdatedBy.lastName string

ユーザーの姓。

Email
template.templateLastUpdatedBy.emailId string

ユーザーの電子メール アドレス。

部門
template.templateLastUpdatedBy.department string

ユーザーの部署。

Title
template.templateLastUpdatedBy.title string

ユーザーの役職。

アクティブ
template.templateLastUpdatedBy.active boolean

ユーザー アカウントがアクティブかどうかを示します。

すべてのフィールド
allfields array of object

このテンプレートで定義されているすべてのフィールドの一覧。

フィールド タグ ID
allfields.fieldTagId integer

フィールドの一意識別子。

テンプレート識別子
allfields.templateId integer

このフィールドが属するテンプレートの ID。

会社 ID
allfields.companyId integer

このフィールドが属する会社アカウント。

フィールドの型
allfields.fieldType string

フィールドの型 (例: signfield、initialfield、textfield、datefield、checkboxfield、securedfield、attachmentfield)。

ページ番号
allfields.documentPageNumber integer

このフィールドが配置されているドキュメントのページ番号。

責任を負う当事者
allfields.partyResponsible integer

このフィールドの入力を担当するパーティ シーケンス番号。

パーティー シーケンス
allfields.partyResponsibleSequence integer

責任者の順序の位置。

ドキュメント フィールド ID
allfields.docFieldId string

ドキュメント内のこのフィールドの識別子。

依存先
allfields.dependent boolean

このフィールドの表示が別のフィールドの値に依存するかどうかを示します。

タブ オーダー
allfields.tabOrder integer

フィールド間を移動するためのタブ オーダー。

必須
allfields.required boolean

ドキュメントに署名する前に、このフィールドを完了する必要があるかどうかを示します。

ユーザー設定フィールド名
allfields.customFieldName string

このフィールドに割り当てられたカスタム名。

[すべて共有]
allfields.shareAll boolean

このフィールドがすべてのユーザーと共有されているかどうかを示します。

編集を許可する
allfields.allowEdit boolean

このフィールドを受信者が編集できるかどうかを示します。

テキスト フィールド名
allfields.textfieldName string

テキスト フィールドのラベル (fieldType が 'textfield' の場合に適用されます)。

価値
allfields.value string

フィールドの入力済みまたは入力済みの値。

フォント サイズ
allfields.fontSize integer

このフィールドのテキストに使用されるフォント サイズ。

フォントの色
allfields.fontColor string

このフィールドのテキストに使用されるフォントの色 (#000000 など)。

[読み取り専用]
allfields.readOnly boolean

フィールドが読み取り専用で、受信者が編集できないかどうかを示します。

複数行
allfields.multiLine boolean

テキスト フィールドが複数行の入力を受け入れるかどうかを示します (fieldType が 'textfield' の場合に適用されます)。

文字数制限
allfields.characterLimit integer

フィールドで使用できる最大文字数 (fieldType が 'textfield' の場合に適用されます)。

日付フィールド名
allfields.datefieldName string

日付フィールドのラベル (fieldType が 'datefield' の場合に適用されます)。

日付形式
allfields.dateFormat string

このフィールドで使用される日付形式 (MM/DD/YYYY など) (fieldType が 'datefield' の場合に適用されます)。

チェックボックス名
allfields.cbname string

チェックボックス フィールドのラベル (fieldType が 'checkboxfield' の場合に適用されます)。

チェックボックス グループ
allfields.cbgroup string

このチェック ボックスのグループ名。複数のチェック ボックスがリンクされている場合に使用されます (fieldType が 'checkboxfield' の場合に適用されます)。

確認済み
allfields.checked boolean

チェック ボックスが既定でオンになっているかどうかを示します (fieldType が 'checkboxfield' の場合に適用されます)。

セキュリティで保護されたフィールド名
allfields.securedfieldName string

セキュリティで保護されたフィールドのラベル (fieldType が 'securedfield' の場合に適用されます)。

表示する文字
allfields.charToDisplay integer

セキュリティで保護されたフィールド値の末尾に表示するマスクされていない文字の数 (fieldType が 'securedfield' の場合に適用されます)。

署名 ID
allfields.signatureId string

この署名フィールドに適用される署名の ID (fieldType が 'signfield' の場合に適用されます)。

初期イメージ
allfields.initialImage string

このフィールドに適用されるイニシャルの画像データ (fieldType が 'initialfield' の場合に適用されます)。

添付ファイル フィールド名
allfields.attachmentfieldName string

添付ファイル フィールドの名前 (fieldType が 'attachmentfield' の場合に適用されます)。

添付ファイルの説明
allfields.attachmentfieldDescription string

添付する内容の説明 (fieldType が 'attachmentfield' の場合に適用されます)。

レポートのダウンロード

エンベロープ アクティビティ レポートをMicrosoft Excel ファイルとしてダウンロードします。 フィルターを使用して、状態、日付範囲、封筒名、作成者、または署名者によって結果を絞り込みます。

パラメーター

名前 キー 必須 説明
envelopeStatus
status string

レポートをフィルター処理するフォルダーの状態

作成日の開始日
creationDateFrom string

作成日の範囲の開始。 使用できる形式: YYYY-MM-DD。

作成日
creationDateTo string

作成日の範囲の末尾。 使用できる形式: YYYY-MM-DD。

封筒名
folderName string

この文字列を含む任意のフォルダー。

フィールドを含める
includeFields string

レポートに封筒フィールドの値を含めるには、'true' に設定します。 既定値は 'false' です。

作成者Email
authorEmail string

レポートをフィルター処理して、この作成者のメール アドレスによって作成された封筒のみを含めます。

署名者の電子メール
signerEmail string

レポートをフィルター処理して、このメール アドレスが署名者である封筒のみを含めます。

返品

レポート ファイル
binary

削除された封筒の履歴を取得する

削除またはごみ箱に移動された封筒の履歴を取得します。

パラメーター

名前 キー 必須 説明
封筒 ID
folderId True string

削除履歴を取得するエンベロープの一意識別子。

返品

名前 パス 説明
Result
result string

要求が成功したかどうかを示します。

封筒情報の削除
Deleted Folder Log Info array of object

削除されたエンベロープに関する概要情報。

封筒 ID
Deleted Folder Log Info.folderId integer

削除されたエンベロープの一意識別子。

封筒名
Deleted Folder Log Info.folderName string

削除された封筒の名前。

ドキュメント名
Deleted Folder Log Info.documentName string

削除された封筒内のドキュメントの名前。

ドキュメント ID
Deleted Folder Log Info.documentId string

削除されたエンベロープ内のドキュメントの一意識別子。

削除日
Deleted Folder Log Info.deletionDate integer

エンベロープが削除された日付と時刻 (Unix ミリ秒)。

削除者
Deleted Folder Log Info.deletedBy string

封筒を削除したユーザーの名前。

削除ログの履歴
Deleted Folder Log History array of object

エンベロープに対して実行されたすべての削除アクションのステップ バイ ステップ ログ。

実行者
Deleted Folder Log History.partiesName string

削除手順を実行したユーザーの名前。

Source
Deleted Folder Log History.source string

削除が開始されたソース (Web、API など)。

Event
Deleted Folder Log History.event string

実行された特定の削除アクション (フォルダーの削除、フォルダーからすべてのパーティの削除など)。

単一ドキュメント PDF のダウンロード

封筒から 1 つのドキュメントを PDF ファイルとしてダウンロードします。

パラメーター

名前 キー 必須 説明
封筒 ID
folderId True string

ダウンロードするドキュメントを含む封筒の一意識別子。

ドキュメント番号
docNumber True string

1 から始まる、ダウンロードするドキュメントのインデックス。

返品

response
binary

封筒のキャンセル

送信された封筒をキャンセルします。 受信者はドキュメントに署名できなくなります。

パラメーター

名前 キー 必須 説明
封筒 ID
folderId True integer

キャンセルする封筒の ID。

取り消しの理由
reason_for_cancellation True string

この封筒をキャンセルする理由。 これはエンベロープ アクティビティ履歴に記録されます。

返品

名前 パス 説明
Result
result string

要求が成功したかどうかを示します。

取り消されたエンベロープ ID
folders cancelled array of integer

正常に取り消されたエンベロープ ID の一覧。

封筒の詳細を取得する

封筒の状態、受信者、ドキュメントなど、封筒の完全な詳細を取得します。

パラメーター

名前 キー 必須 説明
封筒 ID
folderId True integer

取得するエンベロープの一意識別子。

アクセストークン
access_token string

認証用の OAuth 2.0 アクセス トークン。

返品

名前 パス 説明
Result
result string

操作が成功したかどうかを示します (例: 'success')。

ID
folder.folderId integer

封筒の一意の ID。

名前
folder.folderName string

封筒の名前。

作成者 ID
folder.folderAuthorId integer

エンベロープを作成したユーザーの一意の ID。

作成者名
folder.folderAuthorFirstName string

封筒作成者の名。

作成者の姓
folder.folderAuthorLastName string

封筒作成者の姓。

作成者Email
folder.folderAuthorEmail string

封筒作成者のメール アドレス。

作成者ロール
folder.folderAuthorRole string

エンベロープ作成者のアカウント ロール。

会社 ID
folder.folderCompanyId integer

封筒が属する会社の一意の ID。

[作成日付]
folder.folderCreationDate integer

エンベロープが作成された日付と時刻 (Unix ミリ秒)。

送信日
folder.folderSentDate integer

封筒が受信者に送信された日付と時刻 (Unix ミリ秒)。 まだ送信されていない場合は Null。

地位
folder.folderStatus string

エンベロープの現在の状態 (SHARED、EXECUTED、DRAFT、CANCELLED など)。

ドキュメント ID
folder.folderDocumentIds array of integer

この封筒に含まれるドキュメント ID の一覧。

ドキュメント​
folder.documentsList array of object

封筒に含まれる各ドキュメントの詳細。

ドキュメント ID
folder.documentsList.documentId integer

ドキュメントの一意識別子。

コントラクト ID
folder.documentsList.contractId integer

このドキュメントに関連付けられているコントラクトの一意識別子。

会社 ID
folder.documentsList.companyId integer

このドキュメントが属する会社の一意の ID。

作成者
folder.documentsList.contractCreatedBy integer

コントラクトを作成したユーザーのユーザー ID。

作成日
folder.documentsList.contractCreatedOn integer

コントラクトが作成された日付 (Unix ミリ秒)。

コントラクトの種類
folder.documentsList.contractType string

コントラクトの型またはカテゴリ。

ドキュメントの状態
folder.documentsList.contractStatus string

ドキュメントの現在の署名状態 (例: WAITING_FOR_SIGNATURE、EXECUTED)。

編集可能
folder.documentsList.editable boolean

ドキュメントを編集できるかどうかを示します。

バージョン ID
folder.documentsList.contractVersionId integer

現在のドキュメント バージョンの一意の ID。

バージョン名
folder.documentsList.contractVersionName string

現在のドキュメント バージョンの名前。

バージョンの説明
folder.documentsList.contractVersionDesc string

現在のドキュメント バージョンの説明。

作成者のバージョン
folder.documentsList.versionCreatedby integer

このドキュメント バージョンを作成したユーザーのユーザー ID。

作成日のバージョン
folder.documentsList.versionCreatedOn integer

このドキュメント バージョンが作成された日付 (Unix ミリ秒)。

バージョン番号
folder.documentsList.contractVersionNumber integer

ドキュメントのバージョン番号。

受取人
folder.folderRecipientParties array of object

署名状態とアクセス リンクを含む、この封筒の受信者の一覧。

受信者 ID
folder.folderRecipientParties.partyId integer

受信者の一意識別子。

受信者 ID
folder.folderRecipientParties.partyDetails.partyId integer

受信者の一意識別子。

名前
folder.folderRecipientParties.partyDetails.firstName string

受信者の名前。

folder.folderRecipientParties.partyDetails.lastName string

受信者の姓。

Email
folder.folderRecipientParties.partyDetails.emailId string

受信者の電子メール アドレス。

住所
folder.folderRecipientParties.partyDetails.address string

受信者のアドレス。

アカウントの作成日
folder.folderRecipientParties.partyDetails.dateCreated integer

受信者のアカウントが作成された日付 (Unix ミリ秒)。

Permissions
folder.folderRecipientParties.contractPermissions string

この受信者に付与された署名アクセス許可 (例: FILL_FIELDS_AND_SIGN)。

署名順序
folder.folderRecipientParties.partySequence integer

署名順序でのこの受信者の位置。

ワークフロー シーケンス
folder.folderRecipientParties.workflowSignSequence integer

この受信者のワークフロー署名シーケンス番号。

封筒 ID
folder.folderRecipientParties.envelopeId integer

この受信者が属する封筒の ID。

共有モード
folder.folderRecipientParties.sharingMode string

この受信者とドキュメントを共有するために使用されるメソッド (電子メールなど)。

署名 URL
folder.folderRecipientParties.folderAccessURL string

この受信者の一意の署名 URL。 封筒が既に完了または取り消されている場合は Null。

セキュリティ モード
folder.folderRecipientParties.securityMode string

この受信者のアクセスに適用されるセキュリティ モード。

追加のコメント
folder.folderRecipientParties.extraComments string

この受信者の署名の招待に含まれる追加のコメント。

作成者アクセス URL
folder.folderAccessURLForAuthor string

ドキュメントにアクセスするためのエンベロープ作成者の URL。 該当しない場合は Null。

一括 ID
folder.bulkId integer

このエンベロープが属する一括送信バッチの ID (存在する場合)。

署名順序を適用する
folder.enforceSignWorkflow boolean

受信者が指定した順序でサインインする必要があるかどうかを示します。

現在のワークフロー ステップ
folder.currentWorkflowStep integer

署名ワークフローの現在のステップ。

トランザクション ソース
folder.transactionSource string

このエンベロープ トランザクションを開始したソース。

編集可能
folder.editable boolean

封筒を編集できるかどうかを示します。

In-Person 署名
folder.inPersonSignable boolean

封筒を個人でサインインできるかどうかを示します。

アラームをオーバーライドする
folder.overrideAccountReminders boolean

この封筒のアカウント レベルのアラーム設定をオーバーライドするかどうかを示します。

ID
folder.envelopeId integer

封筒の一意の ID。 エンベロープ ID (folderId) と同じ値。

名前
folder.envelopeName string

封筒の名前。 封筒名 (folderName) と同じ値。

発信元 ID
folder.envelopeOriginatorId integer

封筒を作成したユーザーのユーザー ID。

会社 ID
folder.envelopeCompanyId integer

封筒が属する会社の ID。

Date
folder.envelopeDate integer

エンベロープが作成された日付と時刻 (Unix ミリ秒)。

共有日
folder.envelopeSharedDate integer

封筒が受信者と共有された日付と時刻 (Unix ミリ秒)。 まだ共有されていない場合は Null。

地位
folder.envelopeStatus string

封筒の現在の状態。 封筒の状態 (folderStatus) と同じ値。

コントラクト ID
folder.envelopeContractIds array of integer

このエンベロープに関連付けられているコントラクト ID の一覧。

パーティのアクセス許可
folder.envelopePartyPermissions array of object

受信者とその署名アクセス許可の一覧。 受信者と同じ構造。

受信者 ID
folder.envelopePartyPermissions.partyId integer

受信者の一意識別子。

名前
folder.envelopePartyPermissions.partyDetails.firstName string

受信者の名前。

folder.envelopePartyPermissions.partyDetails.lastName string

受信者の姓。

Email
folder.envelopePartyPermissions.partyDetails.emailId string

受信者の電子メール アドレス。

Permissions
folder.envelopePartyPermissions.contractPermissions string

この受信者の署名アクセス許可。

署名順序
folder.envelopePartyPermissions.partySequence integer

署名順序でのこの受信者の位置。

署名 URL
folder.envelopePartyPermissions.folderAccessURL string

この受信者の一意の署名 URL。

すべてのフィールド
allFields array of object

封筒のドキュメントに配置されたすべての署名フィールドとフォーム フィールドの一覧。

フィールド ID
allFields.fieldTagId integer

フィールドの一意識別子。

ドキュメント ID
allFields.contractId integer

このフィールドが属するドキュメントの ID。

バージョン ID
allFields.versionId integer

このフィールドが属するドキュメントのバージョン ID。

フィールドの型
allFields.fieldType string

フィールドの型 (例: signfield、textfield、datefield、checkboxfield、dropdownfield、initialfield)。

ページ番号
allFields.documentPageNumber integer

このフィールドが配置されているページ番号。

フィールド ドキュメント ID
allFields.docFieldId string

このフィールドのドキュメント レベルの識別子。

責任当事者
allFields.partyResponsible integer

このフィールドの入力を担当するパーティ ID。

依存している
allFields.dependent boolean

このフィールドの表示が別のフィールドの値に依存するかどうかを示します。

必須
allFields.required boolean

ドキュメントを送信する前に、このフィールドを入力する必要があるかどうかを示します。

フィールド値
allFields.value string

フィールドの現在の値 (入力されている場合)。

フィールド値
allFieldsNameValue array of object

すべてのフィールド名とその現在の値の簡略化されたリスト。 これを使用して、署名された封筒から入力されたフィールド データを読み取る。

フィールド ID
allFieldsNameValue.fieldId integer

フィールドの一意識別子。

ドキュメント ID
allFieldsNameValue.documentId integer

このフィールドが属するドキュメントの ID。

バージョン ID
allFieldsNameValue.documentVersionId integer

このフィールドが属するドキュメントのバージョン ID。

フィールドの型
allFieldsNameValue.fieldType string

フィールドの型 (例: textfield、signfield、datefield、checkboxfield、dropdownfield)。

フィールド名
allFieldsNameValue.name string

テンプレートで定義されているフィールドのラベルまたは名前。

フィールド値
allFieldsNameValue.value string

このフィールドに対して入力または選択された値。

封筒の履歴
Folder History array of object

このエンベロープに対して実行されたすべてのアクションの監査証跡 (時系列)。

名前
Folder History.firstName string

アクションを実行したユーザーの名。

Folder History.lastName string

アクションを実行したユーザーの姓。

Email
Folder History.email string

アクションを実行したユーザーの電子メール アドレス。

封筒 ID
Folder History.envelopeId integer

アクションが実行されたエンベロープの ID。

Date
Folder History.dateChanged integer

アクションが発生した日付と時刻 (Unix ミリ秒)。

関係者 ID
Folder History.changeDoneByParty integer

アクションを実行したユーザーのパーティー ID。

Action
Folder History.action string

エンベロープに対して実行されたアクション (例: Created、InviteSentTo、InviteAccepted、Signed、Executed)。

封筒をごみ箱に移動する

1 つ以上の封筒をごみ箱に移動します。 ごみ箱内の封筒は完全には削除されません。

パラメーター

名前 キー 必須 説明
フォルダー ID
folderIds True array of integer

処理するエンベロープ ID の配列。

返品

名前 パス 説明
Result
result string

操作が成功したかどうかを示します。

封筒を削除する

1 つ以上の封筒を完全に削除します。

パラメーター

名前 キー 必須 説明
フォルダー ID
folderIds True array of integer

処理するエンベロープ ID の配列。

返品

名前 パス 説明
Result
result string

操作が成功したかどうかを示します。

封筒ファイルのダウンロード

封筒から完成したドキュメントをファイルとしてダウンロードします。

パラメーター

名前 キー 必須 説明
封筒 ID
folderId True string

ドキュメントをダウンロードする封筒の一意識別子。

返品

response
binary

署名の通知を送信する

封筒の保留中の受信者にリマインダー通知を送信し、署名を完了するように求めます。

パラメーター

名前 キー 必須 説明
封筒 ID
folderId True integer

封筒の ID。

返品

名前 パス 説明
Result
result string

要求が成功したかどうかを示します。

封筒 ID
reminder sent integer

アラームが送信された封筒の ID。

電子メール グループの詳細を取得する

既存の電子メール グループの詳細を取得します。

パラメーター

名前 キー 必須 説明
電子メール グループ名
emailGroupNames True array of string

グループを識別するために使用される電子メール グループ名の配列。

返品

名前 パス 説明
電子メール グループ
allEmailGroups array of object

要求されたグループ名と一致する電子メール グループの一覧。

グループ識別子
allEmailGroups.groupId integer

電子メール グループの一意識別子。

グループ名
allEmailGroups.groupName string

電子メール グループの名前。

グループの説明
allEmailGroups.groupDesc string

電子メール グループの説明。

作成日
allEmailGroups.dateCreated integer

電子メール グループが作成された日付 (Unix ミリ秒)。

会社 ID
allEmailGroups.companyId integer

この電子メール グループが属している会社アカウント。

Parties
allEmailGroups.parties array of object

このメール グループ内の受信者の一覧。

名前
allEmailGroups.parties.firstName string

受信者の名。

allEmailGroups.parties.lastName string

受信者の姓。

Email
allEmailGroups.parties.emailId string

受信者のメール アドレス。

電子メール グループを作成する

一度に複数の受信者に封筒を送信するために使用できる新しい電子メール グループを作成します。

パラメーター

名前 キー 必須 説明
グループ名
emailGroupName True string

新しい電子メール グループの名前。

グループの説明
emailGroupDescription string

電子メール グループの説明 (省略可能)。

詳細な電子メール検証を許可する
allowAdvancedEmailValidation boolean

有効にすると、Foxit eSign は、送信前にグループ内のすべてのメール アドレスに到達可能であることを検証します。

名前
firstName True string

受信者の名。

lastName True string

受信者の姓。

Email
emailId True string

受信者のメール アドレス。

返品

名前 パス 説明
Result
result string

要求が成功したかどうかを示します。

Message
message string

実行されたアクションの確認メッセージ。

グループ識別子
emailGroup.groupId integer

電子メール グループの一意識別子。 この ID は、グループに封筒を送信するときに使用します。

グループ名
emailGroup.groupName string

電子メール グループの名前。

グループの説明
emailGroup.groupDesc string

電子メール グループの説明。

作成日
emailGroup.dateCreated integer

電子メール グループが作成された日付 (Unix ミリ秒)。

会社 ID
emailGroup.companyId integer

この電子メール グループが属している会社アカウント。

Parties
emailGroup.parties array of object

電子メール グループ内の受信者の一覧。

名前
emailGroup.parties.firstName string

受信者の名。

emailGroup.parties.lastName string

受信者の姓。

Email
emailGroup.parties.emailId string

受信者のメール アドレス。

トリガー

エンベロープが完全に実行されたとき

すべての受信者が署名し、エンベロープが完全に実行されたときにトリガーされます。

封筒が削除されたとき

エンベロープが削除されたときにトリガーされます。

封筒が取り消されたとき

受信者または送信者によって封筒が取り消されたときにトリガーされます。

封筒が署名されている場合

受信者が封筒に署名したときにトリガーされます。

封筒が送信されたとき

封筒が受信者に送信されたときにトリガーされます。 このイベントは、Webhook Level が 'Account' に設定されている場合にのみ発生します。

封筒を表示する場合

受信者が開いて封筒を表示したときにトリガーされます。

エンベロープが完全に実行されたとき

すべての受信者が署名し、エンベロープが完全に実行されたときにトリガーされます。

パラメーター

名前 キー 必須 説明
チャネル名
channelName True string

アカウントでこの Webhook サブスクリプションを識別する名前。

Webhook レベル
webhookLevel True string

アカウント: すべてのエンベロープ (Web および API) に対して起動します。 API アプリ: API を介して作成されたエンベロープに対してのみ起動します。

Webhook シークレット
webhookSecret string

オプション。 Foxit eSign は、検証のためにこのシークレットを使用して HMAC-SHA-256 で各 webhook ペイロードに署名します。

返品

Webhook イベントが発生したときに Foxit eSign から受信したイベント データ。

WebhookEventPayload
WebhookEventPayload

封筒が削除されたとき

エンベロープが削除されたときにトリガーされます。

パラメーター

名前 キー 必須 説明
チャネル名
channelName True string

アカウントでこの Webhook サブスクリプションを識別する名前。

Webhook レベル
webhookLevel True string

アカウント: すべてのエンベロープ (Web および API) に対して起動します。 API アプリ: API を介して作成されたエンベロープに対してのみ起動します。

Webhook シークレット
webhookSecret string

オプション。 Foxit eSign は、検証のためにこのシークレットを使用して HMAC-SHA-256 で各 webhook ペイロードに署名します。

返品

Webhook イベントが発生したときに Foxit eSign から受信したイベント データ。

WebhookEventPayload
WebhookEventPayload

封筒が取り消されたとき

受信者または送信者によって封筒が取り消されたときにトリガーされます。

パラメーター

名前 キー 必須 説明
チャネル名
channelName True string

アカウントでこの Webhook サブスクリプションを識別する名前。

Webhook レベル
webhookLevel True string

アカウント: すべてのエンベロープ (Web および API) に対して起動します。 API アプリ: API を介して作成されたエンベロープに対してのみ起動します。

Webhook シークレット
webhookSecret string

オプション。 Foxit eSign は、検証のためにこのシークレットを使用して HMAC-SHA-256 で各 webhook ペイロードに署名します。

返品

Webhook イベントが発生したときに Foxit eSign から受信したイベント データ。

WebhookEventPayload
WebhookEventPayload

封筒が署名されている場合

受信者が封筒に署名したときにトリガーされます。

パラメーター

名前 キー 必須 説明
チャネル名
channelName True string

アカウントでこの Webhook サブスクリプションを識別する名前。

Webhook レベル
webhookLevel True string

アカウント: すべてのエンベロープ (Web および API) に対して起動します。 API アプリ: API を介して作成されたエンベロープに対してのみ起動します。

Webhook シークレット
webhookSecret string

オプション。 Foxit eSign は、検証のためにこのシークレットを使用して HMAC-SHA-256 で各 webhook ペイロードに署名します。

返品

Webhook イベントが発生したときに Foxit eSign から受信したイベント データ。

WebhookEventPayload
WebhookEventPayload

封筒が送信されたとき

封筒が受信者に送信されたときにトリガーされます。 このイベントは、Webhook Level が 'Account' に設定されている場合にのみ発生します。

パラメーター

名前 キー 必須 説明
チャネル名
channelName True string

アカウントでこの Webhook サブスクリプションを識別する名前。

Webhook レベル
webhookLevel True string

アカウント: Web または API 経由で送信されたエンベロープに対して発生します。 API アプリ: API を介して作成されたエンベロープに対してのみ起動します。 folder_sent イベントはアカウント レベルでのみ発生します。

Webhook シークレット
webhookSecret string

オプション。 Foxit eSign は、検証のためにこのシークレットを使用して HMAC-SHA-256 で各 webhook ペイロードに署名します。

返品

Webhook イベントが発生したときに Foxit eSign から受信したイベント データ。

WebhookEventPayload
WebhookEventPayload

封筒を表示する場合

受信者が開いて封筒を表示したときにトリガーされます。

パラメーター

名前 キー 必須 説明
チャネル名
channelName True string

アカウントでこの Webhook サブスクリプションを識別する名前。

Webhook レベル
webhookLevel True string

アカウント: すべてのエンベロープ (Web および API) に対して起動します。 API アプリ: API を介して作成されたエンベロープに対してのみ起動します。

Webhook シークレット
webhookSecret string

オプション。 Foxit eSign は、検証のためにこのシークレットを使用して HMAC-SHA-256 で各 webhook ペイロードに署名します。

返品

Webhook イベントが発生したときに Foxit eSign から受信したイベント データ。

WebhookEventPayload
WebhookEventPayload

定義

WebhookEventPayload

Webhook イベントが発生したときに Foxit eSign から受信したイベント データ。

名前 パス 説明
イベント名
event_name string

発生したイベントの名前 (例: folder_sent、folder_signed、folder_executed)。

イベントの日付
event_date integer

イベントが発生した日時 (Unix タイムスタンプ (ミリ秒)。

ID
data.folder.folderId integer

封筒の一意の ID。

名前
data.folder.folderName string

封筒の名前。

カスタム名
data.folder.folderCustomName string

封筒に割り当てられたカスタム名。

パスワード
data.folder.folderPassword string

封筒のアクセス パスワード (設定されている場合)。

作成者 ID
data.folder.folderAuthorId integer

エンベロープ作成者のユーザー ID。

作成者名
data.folder.folderAuthorFirstName string

封筒作成者の名。

作成者の姓
data.folder.folderAuthorLastName string

封筒作成者の姓。

作成者の電子メール
data.folder.folderAuthorEmail string

封筒作成者のメール アドレス。

Creator ロール
data.folder.folderAuthorRole string

エンベロープ作成者のアカウント ロール。

会社 ID
data.folder.folderCompanyId integer

封筒を所有する会社 ID。

作成日
data.folder.folderCreationDate integer

エンベロープが作成された日付 (Unix タイムスタンプ (ミリ秒)。

送信日
data.folder.folderSentDate integer

エンベロープが送信された日付 (Unix タイムスタンプ (ミリ秒)。

地位
data.folder.folderStatus string

封筒の現在の状態。

ユーザー設定フィールド 1
data.folder.custom_field1 string

最初のカスタム メタデータ フィールド。

ユーザー設定フィールド 2
data.folder.custom_field2 string

2 番目のカスタム メタデータ フィールド。

Metadata
data.folder.metadata string

エンベロープに関連付けられているカスタム メタデータ。

ドキュメント ID
data.folder.folderDocumentIds array of integer

封筒内のドキュメント ID の一覧。

ドキュメント​
data.folder.documentsList array of object

封筒内のドキュメントの一覧。

ドキュメント ID
data.folder.documentsList.documentId integer

ドキュメントの一意識別子。

コントラクト ID
data.folder.documentsList.contractId integer

このドキュメントのコントラクト ID。

会社 ID
data.folder.documentsList.companyId integer

このドキュメントの会社 ID。

作成者
data.folder.documentsList.contractCreatedBy integer

コントラクトを作成したユーザーのユーザー ID。

作成日
data.folder.documentsList.contractCreatedOn integer

コントラクトが作成された日付 (Unix タイムスタンプ (ミリ秒単位)。

コントラクトの種類
data.folder.documentsList.contractType string

コントラクトの型。

コントラクトの状態
data.folder.documentsList.contractStatus string

コントラクトの現在の状態。

編集可能
data.folder.documentsList.editable boolean

ドキュメントが編集可能かどうかを示します。

バージョン ID
data.folder.documentsList.contractVersionId integer

コントラクトのバージョン ID。

バージョン名
data.folder.documentsList.contractVersionName string

コントラクト バージョンの名前。

バージョンの説明
data.folder.documentsList.contractVersionDesc string

コントラクト バージョンの説明。

作成者のバージョン
data.folder.documentsList.versionCreatedby integer

このバージョンを作成したユーザーのユーザー ID。

作成日のバージョン
data.folder.documentsList.versionCreatedOn integer

このバージョンが作成された日付 (Unix タイムスタンプ (ミリ秒)。

バージョン番号
data.folder.documentsList.contractVersionNumber integer

コントラクトのバージョン番号。

トランザクション ソース
data.folder.documentsList.contractTransactionSource string

コントラクトを開始したソース システム。

受取人
data.folder.folderRecipientParties array of object

この封筒の受信者の一覧。

受信者 ID
data.folder.folderRecipientParties.partyId integer

受信者の一意識別子。

受信者 ID
data.folder.folderRecipientParties.partyDetails.partyId integer

受信者の一意の ID。

名前
data.folder.folderRecipientParties.partyDetails.firstName string

受信者の名前。

data.folder.folderRecipientParties.partyDetails.lastName string

受信者の姓。

Email
data.folder.folderRecipientParties.partyDetails.emailId string

受信者の電子メール アドレス。

プレースホルダー
data.folder.folderRecipientParties.partyDetails.placeholder boolean

これがプレースホルダーの受信者かどうか。

住所
data.folder.folderRecipientParties.partyDetails.address string

受信者のアドレス。

作成日
data.folder.folderRecipientParties.partyDetails.dateCreated integer

受信者レコードが作成された日付 (Unix タイムスタンプ (ミリ秒)。

電子メールをオプトアウトする
data.folder.folderRecipientParties.partyDetails.optOutEmails boolean

受信者がメールをオプトアウトしたかどうか。

一意の ID
data.folder.folderRecipientParties.partyDetails.uniquePartyId string

この受信者の一意のシステム識別子。

認証レベル
data.folder.folderRecipientParties.partyDetails.authenticationLevel string

この受信者の認証方法。

パスワードの更新日
data.folder.folderRecipientParties.partyDetails.passwordUpdateDate string

パスワードが最後に更新された日付。

パスワードの状態
data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

パスワードが更新されたかどうか。

ダイヤル コード
data.folder.folderRecipientParties.dialingCode string

国際ダイヤル コード。

Mobile
data.folder.folderRecipientParties.mobileNumber string

受信者の携帯電話番号。

署名の種類
data.folder.folderRecipientParties.signerSignatureType string

署名者が使用する署名の種類。

Permissions
data.folder.folderRecipientParties.contractPermissions string

この受信者に付与されたアクセス許可。

署名順序
data.folder.folderRecipientParties.partySequence integer

この受信者の署名順序。

ワークフロー シーケンス
data.folder.folderRecipientParties.workflowSignSequence integer

ワークフロー署名シーケンス番号。

封筒 ID
data.folder.folderRecipientParties.envelopeId integer

この受信者に関連付けられているエンベロープ ID。

受信者の会社 ID
data.folder.folderRecipientParties.partyCompanyId integer

この受信者の会社 ID。

共有モード
data.folder.folderRecipientParties.sharingMode string

この受信者の共有モード。

受信者の署名 URL
data.folder.folderRecipientParties.folderAccessURL string

この受信者が封筒にアクセスして署名するための URL。

セキュリティ モード
data.folder.folderRecipientParties.securityMode string

この受信者のセキュリティ モード。

コメント
data.folder.folderRecipientParties.extraComments string

受信者の追加のコメント。

名前の変更を許可する
data.folder.folderRecipientParties.allowNameChange boolean

受信者が自分の名前を更新できるかどうか。

更新された名前
data.folder.folderRecipientParties.signerNameUpdated boolean

署名者が自分の名前を更新したかどうか。

署名者の認証レベル
data.folder.folderRecipientParties.signerAuthenticationLevel string

署名者に必要な認証レベル。

アクセス コード
data.folder.folderRecipientParties.userDefinedAccessCode string

署名者のカスタム アクセス コード。

署名 ID
data.folder.folderRecipientParties.signatureId string

適用された署名の ID。

Role
data.folder.folderRecipientParties.partyRole string

署名ワークフローにおけるこの受信者のロール。

会社フィールド
data.folder.folderRecipientParties.companyFieldValue string

会社名フィールドの値。

タイトル フィールド
data.folder.folderRecipientParties.titleFieldValue string

タイトル フィールドの値。

署名の理由
data.folder.folderRecipientParties.reasonSigning string

署名の理由。

支払フィールドの追加
data.folder.folderRecipientParties.payFieldAdded boolean

支払フィールドが追加されたかどうか。

受取 人
data.folder.folderRecipientParties.payee boolean

この受信者が支払い先かどうか。

定期支払い
data.folder.folderRecipientParties.recurringFieldExist boolean

定期支払フィールドが存在するかどうか。

印刷と署名の完了
data.folder.folderRecipientParties.printAndSignCompleted boolean

印刷と署名が完了したかどうか。

省略可能な署名者
data.folder.folderRecipientParties.allowOptionalSigner boolean

この受信者が省略可能な署名者であるかどうか。

省略可能な署名者
data.folder.folderRecipientParties.optionalSigners array of integer

オプションの署名者パーティ ID。

有料
data.folder.folderRecipientParties.paid boolean

支払いが完了したかどうか。

作成者アクセス URL
data.folder.folderAccessURLForAuthor string

封筒にアクセスするための封筒作成者の URL。

下書きアクセス URL
data.folder.draftFolderAccessURL string

ドラフト状態のエンベロープにアクセスするための URL。

ボードルーム署名
data.folder.boardRoomSign boolean

ボードルーム署名モードが有効になっているかどうか。

ロゴを含める
data.folder.includeLogo boolean

会社のロゴが電子メールに含まれているかどうか。

ボタンの背景色
data.folder.email_btnBgColor string

電子メール アクション ボタンの背景色。

ボタンテキストの色
data.folder.email_btnTxtColor string

電子メール アクション ボタンのテキストの色。

電子メール のロゴ
data.folder.emailTemplateLogo string

電子メール テンプレートで使用されるロゴ URL。

電子メール テンプレート ID
data.folder.emailTemplateId integer

使用する電子メール テンプレートの ID。

電子メール ヘッダー
data.folder.emailHeader string

通知メールのヘッダー テキスト。

電子メール フッター
data.folder.emailFooter string

通知メールのフッター テキスト。

スケジュールされた消去
data.folder.purgeFlag boolean

エンベロープの消去がスケジュールされているかどうかを示します。

消去の開始日
data.folder.purgeStartDate string

消去スケジュールの開始日。

終了日を消去する
data.folder.purgeEndDate string

消去スケジュールの終了日。

一括 ID
data.folder.bulkId integer

一括送信操作 ID (該当する場合)。

署名順序を適用する
data.folder.enforceSignWorkflow boolean

受信者が定義された順序でサインインする必要があるかどうか。

現在のワークフロー ステップ
data.folder.currentWorkflowStep integer

署名ワークフローの現在のステップ。

トランザクション ソース
data.folder.transactionSource string

このトランザクションを開始したソース システム。

編集可能
data.folder.editable boolean

封筒が編集可能かどうか。

In-Person 署名
data.folder.inPersonSignable boolean

封筒が対人署名をサポートしているかどうか。

アラームをオーバーライドする
data.folder.overrideAccountReminders boolean

アカウント レベルのアラーム設定をオーバーライドするかどうかを指定します。

委任のオーバーライド
data.folder.overrideAccountRecipientDelegation boolean

アカウント レベルの委任設定をオーバーライドするかどうかを指定します。

委任を許可する
data.folder.allowRecipientsToDelegate boolean

受信者が署名を委任できるかどうか。

ID
data.folder.envelopeId integer

一意のエンベロープ ID (folderId のエイリアス)。

名前
data.folder.envelopeName string

封筒名 (folderName のエイリアス)。

発信元 ID
data.folder.envelopeOriginatorId integer

封筒を作成したユーザー ID。

会社 ID
data.folder.envelopeCompanyId integer

封筒を所有する会社 ID。

Date
data.folder.envelopeDate integer

エンベロープが作成された日付 (Unix タイムスタンプ (ミリ秒)。

共有日
data.folder.envelopeSharedDate integer

エンベロープが共有された日付 (Unix タイムスタンプ (ミリ秒)。

地位
data.folder.envelopeStatus string

封筒の現在の状態。

コントラクト ID
data.folder.envelopeContractIds array of integer

このエンベロープに関連付けられているコントラクト ID。

パーティのアクセス許可
data.folder.envelopePartyPermissions array of object

受信者のアクセス許可リスト (受信者と同じ構造)。

受信者 ID
data.folder.envelopePartyPermissions.partyId integer

受信者の一意識別子。

受信者 ID
data.folder.envelopePartyPermissions.partyDetails.partyId integer
名前
data.folder.envelopePartyPermissions.partyDetails.firstName string
data.folder.envelopePartyPermissions.partyDetails.lastName string
Email
data.folder.envelopePartyPermissions.partyDetails.emailId string
プレースホルダー
data.folder.envelopePartyPermissions.partyDetails.placeholder boolean
住所
data.folder.envelopePartyPermissions.partyDetails.address string
作成日
data.folder.envelopePartyPermissions.partyDetails.dateCreated integer
電子メールをオプトアウトする
data.folder.envelopePartyPermissions.partyDetails.optOutEmails boolean
一意の ID
data.folder.envelopePartyPermissions.partyDetails.uniquePartyId string
認証レベル
data.folder.envelopePartyPermissions.partyDetails.authenticationLevel string
パスワードの更新日
data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string
パスワードの状態
data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean
ダイヤル コード
data.folder.envelopePartyPermissions.dialingCode string
Mobile
data.folder.envelopePartyPermissions.mobileNumber string
署名の種類
data.folder.envelopePartyPermissions.signerSignatureType string
Permissions
data.folder.envelopePartyPermissions.contractPermissions string
署名順序
data.folder.envelopePartyPermissions.partySequence integer
ワークフロー シーケンス
data.folder.envelopePartyPermissions.workflowSignSequence integer
封筒 ID
data.folder.envelopePartyPermissions.envelopeId integer
受信者の会社 ID
data.folder.envelopePartyPermissions.partyCompanyId integer
共有モード
data.folder.envelopePartyPermissions.sharingMode string
受信者の署名 URL
data.folder.envelopePartyPermissions.folderAccessURL string
セキュリティ モード
data.folder.envelopePartyPermissions.securityMode string
コメント
data.folder.envelopePartyPermissions.extraComments string
名前の変更を許可する
data.folder.envelopePartyPermissions.allowNameChange boolean
更新された名前
data.folder.envelopePartyPermissions.signerNameUpdated boolean
署名者の認証レベル
data.folder.envelopePartyPermissions.signerAuthenticationLevel string
アクセス コード
data.folder.envelopePartyPermissions.userDefinedAccessCode string
署名 ID
data.folder.envelopePartyPermissions.signatureId string
Role
data.folder.envelopePartyPermissions.partyRole string
会社フィールド
data.folder.envelopePartyPermissions.companyFieldValue string
タイトル フィールド
data.folder.envelopePartyPermissions.titleFieldValue string
署名の理由
data.folder.envelopePartyPermissions.reasonSigning string
支払フィールドの追加
data.folder.envelopePartyPermissions.payFieldAdded boolean
受取 人
data.folder.envelopePartyPermissions.payee boolean
定期支払い
data.folder.envelopePartyPermissions.recurringFieldExist boolean
印刷と署名の完了
data.folder.envelopePartyPermissions.printAndSignCompleted boolean
省略可能な署名者
data.folder.envelopePartyPermissions.allowOptionalSigner boolean
省略可能な署名者
data.folder.envelopePartyPermissions.optionalSigners array of integer
有料
data.folder.envelopePartyPermissions.paid boolean
認証レベル
data.folder.envelopeAuthenticationLevel string

エンベロープに必要な認証レベル。

シングル 署名者の一括
data.folder.allowSingleSignerInBulk boolean

シングル 署名者が一括モードで許可されるかどうか。

File-Based フォルダー名
data.folder.folderNameBasedOnFileNaming boolean
File-Based ドキュメント名
data.folder.documentNameBasedOnFileNaming boolean
証明書名の File-Based
data.folder.certificateNameBasedOnFileNaming boolean
Pre-Exec ファイルの名前付け
data.folder.enableFileNamingBeforeExecution boolean
追加された支払い先
data.folder.payeeAddedd boolean
Self-Signing 有効
data.folder.selfSignerEnabled boolean
[公証人が有効]
data.folder.notaryEnabled boolean
制限付き可視性
data.folder.limitedVisibilityFlag boolean
署名後の可視性
data.folder.postSigningVisibility boolean
Wet Signature
data.folder.wetSignatureEnabled boolean
マージが有効
data.folder.mergeEnabled boolean

binary

これは基本的なデータ型 'バイナリ' です。