SigningHub (プレビュー)

SigningHub by Ascertia は、信頼性の高いデジタル署名とドキュメント ワークフローの自動化のための包括的なスイートを提供します。 このコネクタを使用すると、企業はユーザーを安全に認証し、ドキュメント署名要求を開始し、エンド ツー エンドの承認サイクルを管理できます。 厳格なグローバル セキュリティ標準を満たすように設計されているため、自動化されたワークフローは、組織全体で法的に強制可能で透過的で、高度なセキュリティを維持できます。

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

サービス	クラス	リージョン
コピロット スタジオ	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)

お問い合わせ
名前	Support
URL	https://www.signinghub.com/contact-us/
Email	support@ascertia.com

コネクタ メタデータ
Publisher	Ascertia Limited。
Publisher	Ascertia
StackOwner	SigningHub
BrandColor	#1C1C1C
IconBrandColor	#1C1C1C
Web サイト	https://signinghub.com
プライバシー ポリシー	https://www.signinghub.com/privacy-policy
Categories	コンテンツとファイル。生産性

SigningHub コネクタ

SigningHub には、組織がデジタル ドキュメント署名ワークフローを自動化および管理できる包括的な REST API が用意されています。 このコネクタを使用すると、SigningHub とPower Automateを統合して、ドキュメントの承認プロセスを効率化し、カスタム ワークフロー内の署名アクションを自動化できます。

このコネクタを使用すると、ドキュメント署名やその他の SigningHub アクションをPower Automateフロー内で直接自動化できるため、組織は効率的で安全なドキュメント ワークフローを構築できます。

Publisher: Ascertia

前提条件

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

• アクティブな SigningHub アカウント (https://www.signinghub.com)。
• SigningHub で定義されている有効な統合。

資格情報を取得する方法

[ログイン フォーム] フィールドに次の値を入力します。

• 電子メール: SigningHub アカウントの電子メール。
• パスワード: SigningHub アカウントのパスワード。
• API クライアント ID: Ascertia または会社の管理者は、コネクタを使用するための API クライアント ID を指定します。
• API クライアント シークレット: Ascertia または会社の管理者は、コネクタを使用するための API クライアント シークレットを提供します。
• API URL: 既定では、SigningHub API URL https://api.signinghub.com

サポートされている操作

このコネクタは、 SigningHub REST API の一部のカバレッジを提供します。 サポートされているアクションとそのパラメーターの一覧については、 SigningHub API ガイドを参照してください。

サポートとリンク

• 公式 API ドキュメント
• サポート URL
• プライバシー ポリシー

調整制限

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

アクション

CheckBox フィールドの更新	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのチェック ボックス フィールドを更新できます。 すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。 幅と高さは更新できません。 これらは、追加されたときと同じままです。
CheckBox フィールドの追加	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントにチェック ボックスを追加できます。 この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。 詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。 幅と高さのパラメーターを指定しない場合は、既定のサイズである 10 x 10 が割り当てられます。 幅または高さ (または両方) が指定されている場合、システムはこれらの指定された値を相互に比較します。 幅と高さの間の大きい値は、両方のディメンションに割り当てられます。
Enterprise パッケージのワークフロー ユーザー認証 (ドキュメントを開く) を更新する	ビジネス アプリケーションでは、このサービス API を使用して、受信者のパッケージ認証とアクセス期間を更新できます。 この API は、認証要求で "スコープ" 変数が使用された場合に、エンタープライズ管理者またはエンタープライズ ユーザーが使用することもできます。
Gatekeeper 承認ドキュメント	ビジネス アプリケーションでは、このサービス API を使用して、指定されたユーザーによるドキュメントの承認を順番にゲートキーパーで行うことができます。
QR コードの追加	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントに QR コードを追加できます。
QR コードを更新する	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントの QR コードを更新できます。
RadioBox フィールドの更新	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのラジオ ボタンを更新できます。 すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。 幅と高さは更新できません。 これらは、追加されたときと同じままです。
RadioBox フィールドの追加	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントにチェック ボックスを追加できます。 この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。 詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。 幅と高さのパラメーターを指定しない場合は、既定のサイズである 10 x 10 が割り当てられます。 幅または高さ (または両方) が指定されている場合、システムはこれらの指定された値を相互に比較します。 幅と高さの間の大きい値は、両方のディメンションに割り当てられます。
TextBox フィールドを更新する	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのテキスト ボックスを更新できます。 すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。 そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。 後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。
エンタープライズ テンプレートを取得する	ビジネス アプリケーションでは、このサービス API を使用して、現在のユーザーのエンタープライズ テンプレートの一覧を取得できます。 これは、認証要求で "scope" 変数が使用された場合、エンタープライズ管理者またはエンタープライズ ユーザーを意味します。 "x-search-text" ヘッダーの下に指定された条件に基づいて検索できます。
エンタープライズ パッケージのワークフロー ユーザー認証 (ドキュメントを開く) を取得する	ビジネス アプリケーションでは、このサービス API を使用して、パッケージのアクセス セキュリティ設定を有効にすることができます。 セキュリティが構成されている受信者は、URL 内の順序によって識別されます。 パッケージ ID は、要求 URL でも識別されます。 アクセス セキュリティが有効になっている場合、受信者はこの期間の範囲外のドキュメント パッケージにアクセスできません。 ドキュメント所有者は、受信者のパッケージの認証ベースのセキュリティを構成することもできます。
ゲートキーパー辞退ドキュメント	ビジネス アプリケーションでは、このサービス API を使用して、指定されたユーザーによるドキュメントの拒否を順番にゲートキーパーで行うことができます。
テキスト ボックス フィールドの追加	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントにテキスト入力フィールドを追加できます。 この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。 詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。
テンプレートを取得する	ビジネス アプリケーションでは、このサービス API を使用して、現在のユーザーのテンプレートの一覧を取得できます。 "x-search-text" ヘッダーの下に指定された条件に基づいて検索できます。さらに、エンタープライズ管理者がユーザー ロールに対して許可されているユーザーの個人用テンプレートまたはエンタープライズ テンプレートを検索することもできます。
デジタル署名フィールドの更新	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのデジタル署名フィールドを更新できます。 すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。
デジタル署名フィールドの追加	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントにデジタル署名フィールドを追加できます。 この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。 詳細については、「 ワークフローへのユーザーの追加 」を参照してください。テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。
ドキュメント パッケージの共有	ビジネス アプリケーションでは、このサービス API を使用して、署名者とドキュメント パッケージを共有し、新しいワークフローを開始できます。 テンプレートを適用し、必要に応じてテンプレートで定義されているユーザーとアクションを更新することで、ドキュメントは既に準備されている必要があります。 共有するパッケージ ID は、リソース URL に指定されます。
ドキュメント フィールドの削除	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのフィールドを削除できます。
ドキュメント フィールドの割り当て	ビジネス アプリケーションでは、このサービス API を使用して、署名フィールドなどの入力フィールドにユーザーを割り当て、署名順序を定義できます。 フィールドはドキュメント内に既に存在している必要があり、ユーザーはワークフローに存在している必要があります。 ワークフロー ドキュメントの ID は、パッケージ識別子と共にリソース URL に指定されます。 受信者がワークフロー内にある場合は、番号が付けられます。番号は 1 から始まり、追加の受信者ごとにカウントされます。したがって、ワークフローに 3 人のユーザーがいる場合は、"1"、"2"、および "3" という番号が付けられます。この API 呼び出しを使用すると、ワークフロー注文番号でユーザーをドキュメントの入力フィールドに割り当てることができます。
ドキュメント フィールドを取得する	ビジネス アプリケーションでは、このサービス API を使用して、イニシャル、イン人物、署名フィールド、フォーム フィールドなどのドキュメント フィールドを取得できます。
ドキュメントに署名する	ビジネス アプリケーションでは、このサービス API を使用して、SigningHub を使用してエンド ユーザーにドキュメントを表示せずにドキュメントに署名できます (電子とデジタルの両方)。 たとえば、ビジネス アプリケーションには、ドキュメントをユーザーに表示する別の方法があり、SigningHub の署名機能のみが必要な場合や、一括操作の場合は、ユーザーがすべてのドキュメントを個別に表示および承認する必要なしに署名することが正当化される場合があります。 署名前にドキュメントに保存する変更がある場合は、署名ドキュメント API を呼び出す前に Fill Form Fields API を呼び出す必要があります。 ドキュメントの必須入力フィールドは、この API が正常に完了する前に完了する必要があることに注意してください。 署名者は、呼び出しで提示されたアクセス トークンによって識別されます。そのため、この呼び出しを行う前に、署名者の 認証 が必要です。スコープ変数を使用してエンタープライズ管理者として認証を行い、ユーザーに代わってドキュメントに署名することはできません。アクセス トークンは、直接認証の結果として署名者に発行する必要があります。 この呼び出しが完了したら、署名者がドキュメントの最後の署名者であった場合、 Finish Document API 呼び出しが呼び出される必要があります。その理由は、その API を呼び出さずにドキュメントがドキュメントの所有者に対して "進行中" の状態のままになるためです。 API が呼び出されると、ドキュメント所有者の状態が "完了" に変わります。 ドキュメントに署名すると、ドキュメント検証 API の 取得から検証 応答が表示されます。 認証の第 1 または第 2 要素 OTP 使用法 サーバー側の署名操作で OTP 認証が有効になっている場合、クライアント アプリケーションは、OTP API 呼び出し による署名者認証 を使用して、モバイル番号の OTP を生成する必要があります。 それぞれのビジネス アプリケーションは、使用から OTP を取得し、API 呼び出しを行うときに送信する必要があります。 これは、要求の "x-otp" ヘッダーを使用して行われます。
ドキュメントの Certify ポリシーを取得する	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントの署名の認定設定を取得できます。
ドキュメントの Certify ポリシーを更新する	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのサーティフィケーション署名設定を更新できます。
ドキュメントのアップロード	ビジネス アプリケーションでは、このサービス API を使用して、エンタープライズ ユーザーのアカウントにリンクされたドキュメント パッケージにドキュメントを追加できます。 ドキュメント情報は HTTP 要求ヘッダーで送信され、ドキュメント バイトは HTTP 要求本文で送信されます。 注: ヘッダー "x-convert-document" が "true" に設定されている場合、SigningHub はサポートされているドキュメント形式を PDF に変換します。 この値が "false" に設定されている場合にサポートされる唯一のケースは、Word形式と XML ドキュメントを保持することです。 SigningHub では、さまざまなドキュメント形式がサポートされており、アップロード時にそれぞれ PDF 形式に変換できます。完全な一覧については、ここをクリックしてください。 注: PDF ドキュメントは、システムへのアップロード時に変更されません。 この呼び出しを使用してドキュメントを追加するには、パッケージが既に存在している必要があることに注意してください。
ドキュメントの削除	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントを削除できます。
ドキュメントの取り消し	ビジネス アプリケーションでは、このサービス API を使用して、進行中のワークフローを停止できます。 ドキュメント ID はリソース URL で指定されます。 再呼び出し後、ドキュメントの状態が自動的に "DRAFT" に変わります。
ドキュメントの名前を変更する	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントの名前を変更できます。
ドキュメントの承認	ビジネス アプリケーションでは、このサービス API を使用して、指定されたユーザーによるドキュメントを順番に承認できます。
ドキュメントの詳細を取得する	ビジネス アプリケーションでは、このサービス API を使用してドキュメントの詳細を取得できます。 ドキュメント ID は、URL に "{document_id}" として指定されます。
ドキュメントの辞退	ビジネス アプリケーションでは、このサービス API を使用して、指定されたユーザーによるドキュメントを順番に拒否できます。
ドキュメントをダウンロードする	ビジネス アプリケーションでは、このサービス API を使用してドキュメント バイトをダウンロードできます。 パッケージ ID とドキュメント ID は、リソース URL で指定されます。
ドキュメントを送信する	SigningHub ロールの 1 つは "エディター" と呼ばれます。 これにより、受信者はドキュメントの入力フィールドを編集できますが、署名は必要ありません。 完了すると、受信者は変更を送信します。 GUI で使用されるボタンは、"送信" と呼ばれます。 これは、エディターが API 呼び出しを介して変更を送信する同等の操作です。 使用可能なすべてのワークフロー受信者ロールの説明については、[ SigningHub ロール ] をクリックします。
パッケージのダウンロード	ビジネス アプリケーションでは、このサービス API を使用して、バイナリ形式でドキュメント パッケージをダウンロードできます。 パッケージ ID はリソース URL で指定されます。 パッケージに含まれるドキュメントが 1 つだけの場合、ダウンロードはバイナリ PDF ドキュメントです。 または、パッケージに複数のドキュメントがある場合、ダウンロードはすべてのドキュメントのバイナリ zip ファイルです。 x-password ヘッダーと x-otp ヘッダーは省略可能です。 ワークフローの作成フェーズでドキュメント所有者が設定した場合は必須です。
パッケージの一括署名	ビジネス アプリケーションでは、この API を使用して、エンド ユーザーにドキュメントを表示することなく、複数のドキュメント (電子とデジタルの両方) に署名、共有、共有できます。 この API には、ドキュメント パッケージに関するビジネス アプリケーションからの情報と、署名、対人フィールド、イニシャル フィールドの詳細が必要です。 一括署名トランザクションが正常に完了すると、API はドキュメント パッケージの状態とトランザクション ID を返します。 Sign Document API とは異なり、この API はドキュメント パッケージに署名するだけでなく、受信者が署名者、編集者、レビュー担当者のいずれであるかに基づいて承認およびレビュー済みとしてマークします。 状態が COMPLETED として返されるドキュメント パッケージは、この API によって署名、承認、またはレビューされています。 一括署名は、すべての署名時認証方法で機能します。 SIGN がbulk_actionとして渡され、パッケージがドラフト状態の場合、署名と共有が自動的に実行されます。 この API は、 事前一括署名ドキュメント API の後で呼び出す必要があります。 署名する前にドキュメントを変更する必要がある場合は、事前一括署名ドキュメント API を呼び出す前に Fill Form Fields API を呼び出す必要があります。 ドキュメントの必須入力フィールドは、この API が正常に完了する前に完了する必要があります。一方、自動入力されたフィールド (名前、電子メール、日付、役職など) は自動的に入力されます。 署名者は、呼び出しで提示されたアクセス トークンによって識別されます。 そのため、この呼び出しを行う前に、署名者の 認証 が必要です。 スコープ変数を使用してエンタープライズ管理者として認証を行い、ユーザーに代わってドキュメントに署名することはできません。 アクセス トークンは、直接認証の結果として署名者に発行する必要があります。 ドキュメントに署名すると、 一括署名状態 API から確認応答が表示されます。 認証の第 1 または第 2 要素 OTP 使用法 サーバー側の署名操作で OTP 認証が有効になっている場合、クライアント アプリケーションは、OTP API 呼び出し による一括署名認証 を使用して、携帯電話番号の OTP を生成する必要があります。 それぞれのビジネス アプリケーションは、使用から OTP を取得し、API 呼び出しを行うときに送信する必要があります。 これは、要求の "x-otp" ヘッダーを使用して行われます。
パッケージの削除	ビジネス アプリケーションでは、このサービス API を使用して、ユーザーの受信トレイからドキュメントを削除できます。 パッケージ ID は、リソース URL に "{package_id}" として指定されます。 ドキュメントの状態が保留中の場合、削除操作の結果として自動的に拒否されます。 ドキュメントの状態が SHARED の場合、ドキュメントは自動的に取り消され、ドキュメントが削除される前にワークフローが停止されます。
パッケージの詳細を取得する	ビジネス アプリケーションでは、このサービス API を使用してパッケージの詳細を取得できます。 この API は、ビジネス アプリケーションが "スコープ認証" を介してエンタープライズ ユーザーに代わってアクションを実行するためにも使用できます。
パッケージの追加	このサービス API は、1 つ以上のドキュメントを保持するドキュメント パッケージを追加または作成するために使用されます。 このパッケージを使用すると、新しいワークフローを開始するためにドキュメントと受信者を追加できます。 前述のように、ドキュメントを操作する場合は、この呼び出しが必須です。 SigningHub にドキュメントをアップロードまたは追加するには、パッケージが存在する必要があります。 1 つのドキュメントでもパッケージの一部です。1 つのドキュメントを含むパッケージです。 注: パッケージは、作成後に必要に応じて名前を変更できます。
パッケージをカスタムフォルダーまたは共有スペースフォルダーに移動する	ビジネス アプリケーションでは、このサービス API を使用して、ドキュメント パッケージを共有スペースまたはユーザーのカスタム フォルダーに移動できます。
パッケージを取得する	ビジネス アプリケーションでは、このサービス API を使用して、さまざまな状態でフィルター処理されたドキュメントの一覧を取得できます。 ユーザーは、1 ページに複数のレコードを指定することで、レコードをページに分割できます。
パッケージ名の変更	このサービス API は、ドキュメント パッケージの名前を変更するために使用されます。 ドキュメント パッケージは、呼び出しの URL 内の一意の識別子によって識別されます。
フォーム フィールドの入力	ビジネス アプリケーションでは、このサービス API を使用して、指定したユーザーがドキュメント内の 1 つ以上のフォーム フィールドに順番に入力できます。
プレースホルダーの更新	ビジネス アプリケーションでは、このサービス API を使用して、ワークフロー内のプレースホルダーを更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用され、ビジネス アプリケーションがワークフロー内の特定の場所所有者の詳細をオーバーライドする場合に便利です。 ワークフロー ドキュメントの ID はリソース URL で指定され、ワークフローの場所の所有者はワークフローに追加される順序によって識別されます。 XML 型ドキュメントの準備中、サポートされているロールの種類は "SIGNER"、"REVIEWER"、"CARBON_COPY" のみです。
プロセス証拠レポートの取得	ビジネス アプリケーションでは、このサービス API を使用して、ドキュメントのワークフロー プロセス証拠レポートをダウンロードできます。
ライブラリからドキュメントを追加または更新する	ビジネス アプリケーションでは、このサービス API を使用して、ユーザーのライブラリからパッケージにドキュメントを追加できます。 パッケージ ID は URL で指定されます。ドキュメントの ID は、コピーするライブラリ ドキュメントを識別するために、リソース URL に "document_id" として指定する必要もあります。 この呼び出しを使用してドキュメントを追加するには、パッケージが既に存在している必要があることに注意してください。
ワークフロー テンプレートの適用	ビジネス アプリケーションでは、このサービス API を使用して、ワークフロー テンプレートをドキュメントに適用できます。 テンプレートを適用する必要があるドキュメント ID は、リソース URL に指定されます。 ドキュメント ID を 0 に設定すると、pacakge 内のすべての文書にテンプレートが適用されます。 テンプレートを適用する際には、次の 2 つの重要な点を覚えておく必要があります。 ポイント 1 - 既にフォーム フィールドが含まれている PDF を使用して適用するテンプレートを作成する場合は、このテンプレートが適用されているドキュメントに事前にこれらのフォーム フィールドが含まれている必要があることを確認します。SigningHub では、フォーム データのみを適用して、それぞれのユーザーに割り当てるのではなく、テンプレートを使用してこれらのフォーム フィールドを作成しません。 ポイント 2 - フォーム フィールドが署名Hub を介して手動で追加される (したがって、もともと PDF に存在しない) 場所に適用されているテンプレートが作成された場合 (署名フィールド、初期、直接署名、チェック ボックス、ラジオ ボタン、テキスト フィールドなど)、そのようなテンプレートを適用すると、これらのフォーム フィールドが文書に既に存在していた場合でも、対象のドキュメントにこれらのフォーム フィールドが作成されます。
ワークフロー ユーザーのアクセス許可を取得する	ビジネス アプリケーションでは、このサービス API を使用して、受信者のドキュメントアクセス許可を取得できます。 受信者は、ワークフロー内の順序によって識別されます。 パッケージの ID はリソース URL で指定されます。
ワークフロー ユーザーのアクセス許可を更新する	ビジネス アプリケーションでは、このサービス API を使用して、ワークフローに既に追加されているユーザーのワークフローアクセス許可を更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用され、ビジネス アプリケーションがワークフロー内のアクセス許可をオーバーライドする場合に便利です。 ドキュメント パッケージの ID はリソース URL で指定され、ワークフロー ユーザーはワークフローに追加された順序で識別されます。
ワークフロー ユーザーの削除	ビジネス アプリケーションでは、このサービス API を使用してワークフロー受信者を削除できます。
ワークフロー ユーザーの取得	ビジネス アプリケーションでは、このサービス API を使用して、パッケージのワークフローの詳細を取得できます。
ワークフロー ユーザーの更新	ビジネス アプリケーションでは、このサービス API を使用して、ワークフローに既に追加されている受信者、グループ、または場所所有者の詳細を更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用され、ビジネス アプリケーションがワークフロー内の特定のユーザーの詳細をオーバーライドする場合に便利です。 ワークフロー ドキュメントの ID はリソース URL で指定され、ワークフロー受信者はワークフローに追加される順序で識別されます。 XML 型のドキュメントの準備では、ロールの種類 "SIGNER"、"REVIEWER"、"CARBON_COPY" のみがサポートされることに注意してください。
ワークフロー ユーザーの順序を更新する	ビジネス アプリケーションでは、このサービス API を使用して、ワークフロー内の受信者の順序を更新できます。
ワークフロー リマインダーの更新	ビジネス アプリケーションでは、このサービス API を使用して、ワークフローに既に追加されている受信者のワークフロー アラームを更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用され、ビジネス アプリケーションがワークフロー内のアラーム設定をオーバーライドする場合に便利です。 ワークフロー ドキュメントの ID はリソース URL で指定され、ワークフロー受信者はワークフローに追加される順序で識別されます。
ワークフロー リマインダーを取得する	ビジネス アプリケーションでは、このサービス API を使用して、ワークフローに既に追加されている受信者のアラームを更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用され、ビジネス アプリケーションがワークフロー内のアラーム設定をオーバーライドする場合に便利です。 ワークフロー ドキュメントの ID はリソース URL で指定され、ワークフロー受信者はワークフローに追加される順序で識別されます。
ワークフローにグループを追加する	ビジネス アプリケーションでは、このサービス API を使用して、グループを受信者としてワークフローに追加できます。 SigningHub グループは、グループのすべてのメンバーに代わってアクション (つまり、署名) を実行できることを意味します。 グループがワークフローの最後のユーザーまたはグループとして追加されることに注意してください。そのため、ワークフローに既に存在する現在のユーザー/グループを削除するには、さらに作業が必要になる場合があります。 XML 型ドキュメントの準備中、サポートされているロールの種類は "SIGNER"、"REVIEWER"、"CARBON_COPY" のみです。
ワークフローにプレースホルダーを追加する	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のワークフローにプレースホルダーを追加できます。 ワークフロー内の目的の受信者の ID がわからない場合は、場所の所有者が必要です。 プレースホルダーは、ワークフローの最後のユーザーとして追加されることに注意してください。そのため、ワークフローに既に存在する現在のユーザー/グループを削除するには、さらに作業が必要になる場合があります。 プレース ホルダーを追加すると、ドキュメントに署名や入力フィールドを追加し、後の段階で個々のユーザーに割り当てることができます。 XML 型ドキュメントの準備中、サポートされているロールの種類は "SIGNER"、"REVIEWER"、"CARBON_COPY" のみです。
ワークフローにユーザーを追加する	ビジネス アプリケーションでは、このサービス API を使用して、ワークフローに受信者を追加できます。 この呼び出しでは、ワークフローに受信者のみが追加されます。 つまり、現在ドキュメント上のフィールドは新しい受信者に自動的に割り当てられず、新しいフィールドも作成されません。 受信者がワークフローの最後のユーザーとして追加されることに注意してください。そのため、ワークフローに既に存在する現在の受信者を削除するには、さらに作業が必要になる場合があります。 フィールド (入力と署名) をドキュメントに追加するには、ワークフローに少なくとも 1 人のユーザーが存在している必要があります。 入力は、1 回の呼び出しで 1 人以上のユーザーを受け入れることに注意してください。 この特定の呼び出しでは、ユーザーは既知の自然人です。 ただし、グループとプレースホルダーにも同じルールが適用されます。 いずれの場合も、受信者はユーザーのグループになり、グループのメンバーはドキュメントに署名できます。プレースホルダーです。後者のケースは、意図した署名者の ID がわからない場合に使用されます。 注: SigningHub ワークフロー署名順序は "1" から始まります。 そのため、現在の受信者がいないワークフローにユーザーを追加すると、新しい署名注文数が開始されます。ワークフローの種類が "カスタム" の場合、"signing_order" パラメーターは必須です。 重要:この API 呼び出しを使用すると、ワークフローの種類に影響する可能性があります。シーケンシャル ワークフローに現在の受信者が存在し、現在の受信者と同じ署名順序で新しい受信者が追加された場合、ワークフローのその部分は順番に自動的に変更されます。そのため、ワークフロー全体は、純粋にシーケンシャルではなく、カスタム型になりました。 2 人または並列の受信者と同じ署名順序を持つ受信者を追加しても、ワークフローは変更されません。ワークフローの特定の時点には、単に 3 人以上の受信者がいます。すべて並列順に表示されます。 XML 型ドキュメントの準備では、サポートされているロールの種類は "SIGNER"、"REVIEWER"、および "CARBON_COPY" であることに注意してください。
ワークフローの詳細を取得する	ビジネス アプリケーションでは、このサービス API を使用して、パッケージのワークフローの詳細を取得できます。
ワークフローの詳細を更新する	ビジネス アプリケーションでは、このサービス API を使用してワークフローの詳細を更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用された後に役立ちますが、ビジネス アプリケーションは認定のアクセス許可または処理後の詳細をオーバーライドする必要があります。 パッケージ ID はリソース URL で指定されます。
ワークフロー履歴を取得する	ビジネス アプリケーションでは、このサービス API を使用して、ドキュメントに対して実行されたアクションの一覧を取得できます。 パッケージ ID はリソース URL で指定されます。 検索フィールド (x-search-text ヘッダー) は、電子メール、ドキュメント名、アクション、infokey、infovalue を対象としています。
一括署名の状態	ビジネス アプリケーションでは、この API を使用して、一括署名パッケージ API によって処理されたドキュメント パッケージの詳細と共に、特定の 一括署名 トランザクションの状態を取得できます。 この API は、一括署名パッケージ API の後で呼び出す必要があります。 署名者は、呼び出しで提示されたアクセス トークンによって識別されます。 そのため、この呼び出しを行う前に、署名者の 認証 が必要です。 スコープ変数を使用してエンタープライズ管理者として認証を行い、ユーザーに代わってドキュメントに署名することはできません。 アクセス トークンは、直接認証の結果として署名者に発行する必要があります。 RAS 署名の場合、ACTION プロパティはREMOTE_AUTHORIZATION_REQURIEDされ、STATUS プロパティは保留中になり、モバイル デバイスを使用して要求を承認する必要があることを示します。 構成されている保証レベルが異なるために一部のドキュメントで署名プロセスが失敗し、ユーザーが失敗したドキュメントの署名プロセスを完了するために署名プロセスを再開する必要がある場合、ACTION プロパティはREINITIATE_SIGNING_PROCESSされ、STATUS プロパティは保留中になります。
中央の完全なワークフロー (ワークフローの終了)	ビジネス アプリケーションは、ワークフローの途中でもワークフローを完了済みとしてマークできます。 このサービス API を使用して、ワークフローの状態を完了に変更します。 まだドキュメントに署名していない受信者がいる場合。 署名はこれ以上必要なく、それ以上受信トレイにドキュメントを表示できなくなります。 ベアラー トークンはドキュメント所有者に属している必要があります。または、エンタープライズ管理者はスコープ変数を使用して、ドキュメント所有者に代わってアクセス トークンを取得してこのアクションを実行できます。
個人フィールドの更新	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントの対人署名フィールドを更新できます。 すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。
個人フィールドの追加	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントに対してユーザー署名フィールドを追加できます。 この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。 詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。 直接会議を開催するには、SigningHub ユーザーがワークフローの一部である必要があります。ロール "INPERSON_HOST" または "SIGNER" を使用して追加する必要があります。 ホスト オプションでは、ドキュメントに署名または入力フィールドは必要ありません。また、署名Hub 以外の登録済みユーザーは、そのユーザーの署名フィールドに署名できます。 これは、SigningHub ユーザーと受信者が同じ場所に存在することが予想される特別なワークフロー シナリオであることに注意してください。この種類の署名は、通常の緩やかな統合方法で電子メール リンクを介してドキュメントを受信者と共有する使用を意図していません。
共有領域の削除	ビジネス アプリケーションでは、このサービス API を使用して共有領域を削除できます。 共有スペースを削除できるかどうかは、割り当てられたエンタープライズ ユーザー ロールの対象となります。 このプロビジョニングを許可するには、エンタープライズ管理者はロール>Document 設定で [共有領域の管理] オプションを有効にします。
共有領域の更新	ビジネス アプリケーションでは、このサービス API を使用して共有領域を更新できます。 共有スペースの更新の可用性は、割り当てられたエンタープライズ ユーザー ロールの対象となります。 このプロビジョニングを許可するには、エンタープライズ管理者はロール>Document 設定で [共有領域の管理] オプションを有効にします。
共有領域を取得する	ビジネス アプリケーションでは、このサービス API を使用して特定の共有領域を取得できます。 この API は、共有スペース、その所有者、コラボレーターに関する情報を返します。
処理の完了	ビジネス アプリケーションでは、このサービス API を使用して、すべての署名フィールドに署名した後にドキュメント処理を完了できます。 この方法は、主に iOS および Android 用のネイティブの SigningHub モバイル アプリと、モバイル Web ユース ケースで使用されます。 それぞれのポータルへの緊密な統合を採用する一般的なビジネス アプリケーションでは、このメソッドを呼び出す必要はありません。 ただし、Sign Document API を使用する場合 (そのため、ユーザーは署名を要求されたドキュメントの視覚的表現を表示されません)、それぞれのワークフローが続行または完了するように、この API を呼び出す必要があります。 たとえば、"ブラインド" 署名ドキュメント API 呼び出しを使用してすべての署名が適用されると、この API が呼び出されるまで、ドキュメントは所有者に "完了" 状態として表示されません。 この API が呼び出されるまで、ドキュメント所有者に "処理中" という状態が表示されます。 ネイティブの SigningHub モバイル アプリとモバイル Web ユース ケース内では、この呼び出しは、各ユーザーが SigningHub に関してそれぞれのアクションを確実に完了するために必要です。たとえば、署名者が SigningHub App でドキュメントに署名した後、このメソッドがアプリケーションによって呼び出され、ワークフローが引き続き処理され、次の署名者に通知されます。 およびドキュメントの状態は、構成されたコールバック URL を介して使用できます。
処理後の更新	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのワークフローにプレースホルダーを追加できます。
初期フィールドの更新	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのイニシャル フィールドを更新できます。 すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。 そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。
初期フィールドの追加	ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントにイニシャル フィールドを追加できます。 この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。 詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。
塗りつぶしのイニシャル	ビジネス アプリケーションでは、このサービス API を使用して、指定されたユーザーがドキュメント内のイニシャル フィールドに順番に入力できます。
添付ファイルのアップロード	ビジネス アプリケーションでは、このサービス API を使用してドキュメントに添付ファイルをアップロードできます。
添付ファイルのダウンロード	ビジネス アプリケーションでは、このサービス API を使用してドキュメントの添付ファイルをダウンロードできます。
添付ファイルの削除	ビジネス アプリケーションでは、このサービス API を使用してドキュメントの添付ファイルを削除できます。
添付ファイルを取得する	ビジネス アプリケーションでは、このサービス API を使用してドキュメントの添付ファイルを取得できます。
自動配置フィールド	ビジネス アプリケーションでは、この API を呼び出して、指定された検索条件に基づいて署名またはユーザー定義のフォーム フィールドをドキュメントに追加できます。 配置オプションは、左、右、上、下です。 ドキュメントが検索され、検索条件が満たされたすべてのインスタンスが処理されます。 これにより、1 回の呼び出しで複数のフィールドを追加できます。 たとえば、ドキュメントをアップロードし、"Sign here:" という単語のすべてのインスタンスの右側に署名フィールドを自動的に配置します。 これにより、時間が節約され、ワークフローから署名が失われないようにします。 API 呼び出しでは、すべての種類のフィールドがサポートされます。すなわち、電子、デジタル、対人、イニシャル、およびテキストフィールドなど。 さらに、API 呼び出しでは "order" 変数がサポートされます。つまり、署名フィールドのセットを 1 人のユーザーに自動的に割り当てることができます。そのため、呼び出しを繰り返して、ワークフロー内の複数のユーザーに署名フィールドを配置して割り当てることができます。 この方法で署名フィールドをドキュメントに追加するには、ワークフローに少なくとも 1 人のユーザーが存在している必要があります。注文番号は、ワークフローの受信者に対応します。 したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。 この API 呼び出しは、同じドキュメントで複数回使用できます。その理由は、ドキュメント上の複数の署名者に対応するためです。受信者または署名者は、呼び出しで渡された "order" 変数によって識別されます。 詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。
連絡先を取得する	ビジネス アプリケーションでは、このサービス API を使用して、現在のユーザーの個人連絡先とエンタープライズ連絡先の両方から連絡先を取得できます。 "x-search-text" ヘッダーの下に指定された条件に基づいて検索できます。さらに、ユーザーの特定の連絡先、またはユーザーが属している企業の連絡先を検索することもできます。 検索応答情報には、ユーザーの電子メール アドレスとそれぞれのユーザー名が含まれます。

CheckBox フィールドの更新

操作 ID:

V4_Checkbox_UpdateCheckBox

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのチェック ボックス フィールドを更新できます。

すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。

幅と高さは更新できません。 これらは、追加されたときと同じままです。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
field_name	field_name	True	string	更新するフィールドの現在の名前。
renamed_as	renamed_as		string	名前の変更が意図されている場合は、フィールドの名前を更新しました。
page_no	page_no	True	integer	フィールドを作成するページ番号。
value	value		string	フィールドの値。 指定できる値は "true" または "false" です。
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。
validation_rule	validation_rule		string	フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

CheckBox フィールドの追加

操作 ID:

V4_Checkbox_AddCheckBox

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントにチェック ボックスを追加できます。

この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。

詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。

幅と高さのパラメーターを指定しない場合は、既定のサイズである 10 x 10 が割り当てられます。 幅または高さ (または両方) が指定されている場合、システムはこれらの指定された値を相互に比較します。 幅と高さの間の大きい値は、両方のディメンションに割り当てられます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
順序	order	True	integer	フィールドが追加されるワークフロー内のユーザーの順序。
page_no	page_no	True	integer	フィールドを作成するページ番号。
field_name	field_name		string	追加する指定されたフィールドの名前。 指定しない場合、一意の自動生成された名前がフィールドに割り当てられます。
value	value		string	フィールドの値。 指定できる値は "true" または "false" です。
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。
validation_rule	validation_rule		string	フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。

返品

Body

AddFieldResponse

Enterprise パッケージのワークフロー ユーザー認証 (ドキュメントを開く) を更新する

操作 ID:

V4_EnterpriseDocuments_UpdateEnterpriseWorkflowAccess

ビジネス アプリケーションでは、このサービス API を使用して、受信者のパッケージ認証とアクセス期間を更新できます。 この API は、認証要求で "スコープ" 変数が使用された場合に、エンタープライズ管理者またはエンタープライズ ユーザーが使用することもできます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ワークフロー アクセスのセキュリティと認証を更新するパッケージ ID。
受信者の順序	order	True	integer	アクセス セキュリティと認証を更新するワークフロー内の受信者の順序。
apply_to_all	apply_to_all	True	boolean	True の 場合は、ワークフロー内のすべての受信者にアクセス セキュリティまたは認証を適用します。
認証	authentication	True		アクセス認証データが含まれている
authentication_signing	authentication_signing			署名認証データが含まれている
access_duration	access_duration	True		ワークフローのアクセス期間を持つ

返品

response

object

Gatekeeper 承認ドキュメント

操作 ID:

V4_Package_GatekeeperApprove

ビジネス アプリケーションでは、このサービス API を使用して、指定されたユーザーによるドキュメントの承認を順番にゲートキーパーで行うことができます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	承認されるパッケージの ID。
理由	reason		string	パッケージを承認する理由。
ドキュメント アクセス パスワード	x-password		string	ドキュメントにアクセスするためにドキュメント所有者によって設定されたパスワード (存在する場合)。 パスワードが設定されていない場合、値は null になります。
ドキュメント One-Time パスワード	x-otp		string	ドキュメント所有者がドキュメントにアクセスするために設定した One-Time パスワード (OTP) (存在する場合)。 OTP が設定されていない場合、値は null になります。

返品

response

object

QR コードの追加

操作 ID:

V4_QR_AddQRCode

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントに QR コードを追加できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
page_no	page_no	True	integer	フィールドを作成するページ番号。
field_name	field_name		string	追加する指定されたフィールドの名前。 指定しない場合、一意の自動生成された名前がフィールドに割り当てられます。
dimensions	dimensions	True		フィールドディメンション
データ	data		string	QR コードでエンコードするプレーン テキスト データ。 既定では、関連するドキュメントにアクセスするために生成される URL です。 例: {base_url}/document/{document_unique_id}
options	options			オプションに関する設定
color	color			色に関する設定
ロゴ	logo			ロゴに関する設定

返品

Body

AddQrCodeResponse

QR コードを更新する

操作 ID:

V4_QR_UpdateQRCode

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントの QR コードを更新できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
field_name	field_name	True	string	更新するフィールドの現在の名前。
renamed_as	renamed_as		string	名前の変更が意図されている場合は、フィールドの名前を更新しました。
page_no	page_no	True	integer	更新する必要があるフィールドのページ番号
dimensions	dimensions	True		フィールドディメンション
データ	data		string	QR コードでエンコードするプレーン テキスト データ。 既定では、関連するドキュメントにアクセスするために生成される URL です。 例: {base_url}/document/{document_unique_id}
options	options			オプションに関する設定
color	color			色に関する設定
ロゴ	logo			ロゴに関する設定

返品

Body

UpdateQrCodeResponse

RadioBox フィールドの更新

操作 ID:

V4_Radio_UpdateRadioBox

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのラジオ ボタンを更新できます。

すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。

幅と高さは更新できません。 これらは、追加されたときと同じままです。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
field_name	field_name	True	string	更新するフィールドの現在の名前。
renamed_as	renamed_as		string	名前の変更が意図されている場合は、フィールドの名前を更新しました。
page_no	page_no	True	integer	フィールドを作成するページ番号。
value	value		string	フィールドの値。 指定できる値は "true" または "false" です。
validation_rule	validation_rule	True		フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。
radio_group_name	radio_group_name	True	string	フィールドが属するグループ名。
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。

返品

response

object

RadioBox フィールドの追加

操作 ID:

V4_Radio_AddRadioBox

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントにチェック ボックスを追加できます。

この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。

詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。

幅と高さのパラメーターを指定しない場合は、既定のサイズである 10 x 10 が割り当てられます。 幅または高さ (または両方) が指定されている場合、システムはこれらの指定された値を相互に比較します。 幅と高さの間の大きい値は、両方のディメンションに割り当てられます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
順序	order	True	integer	フィールドが追加されるワークフロー内のユーザーの順序。
page_no	page_no	True	integer	フィールドを作成するページ番号。
field_name	field_name		string	追加する指定されたフィールドの名前。 指定しない場合、一意の自動生成された名前がフィールドに割り当てられます。
value	value		string	フィールドの値。 指定できる値は "true" または "false" です。
validation_rule	validation_rule	True		フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。
radio_group_name	radio_group_name	True	string
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。

返品

Body

AddFieldResponse

TextBox フィールドを更新する

操作 ID:

V4_TextBox_UpdateTextBox

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのテキスト ボックスを更新できます。

すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。 そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。 後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
field_name	field_name	True	string	更新するフィールドの現在の名前。
field_locale	field_locale		string	フィールドローカル。 使用可能な値は ar-AE |en-US. 省略可能で、既定値は en-US。 この値は型 "DATE" に重要です。
renamed_as	renamed_as		string	名前の変更が意図されている場合は、フィールドの名前を更新しました。
page_no	page_no	True	integer	フィールドを作成するページ番号。
value	value		string	フィールドの値。 型 = DATE の場合、値は ISO 8601 形式に従う必要があります。YYYY-MM-DD hh:mm:ss +00 の形式に従います。 値は日付フィールドのため、クライアント アプリケーションは YYYY-MM-DD を送信し、hh:mm:ss +00 を無視できます。 値が適切な形式でない場合は、エラーが返されます。
max_length (最大長)	max_length	True	integer	フィールドで使用できる値の最大長。 1 ~ 9999 の間
field_type	field_type	True		値の型の受け入れに関するフィールド型。使用可能な値は "NUMBER" または "TEXT" です。
validation_rule	validation_rule	True		フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。
フォント	font			フィールド テキストのフォント
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。
プレースホルダ	placeholder		string	開発者は、独自のプレースホルダー テキストを提供できます。 これらのプレースホルダーは、ビューアーでドキュメントを表示しているときにテキスト フィールドに表示されます。
format	format		string	フィールドのテキスト形式。 日付型フィールドにのみ使用されます。 使用可能な値は次のいずれかです: m/d m/d/yy m/d/yyyy mm/dd/yy mm/dd/yyyy mm/yy mm/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d、yyyy dd/mm/yy ddmmmyyyy
入力規則	validation			Validations

返品

response

object

エンタープライズ テンプレートを取得する

操作 ID:

V4_Template_GetEnterpriseTemplates

ビジネス アプリケーションでは、このサービス API を使用して、現在のユーザーのエンタープライズ テンプレートの一覧を取得できます。 これは、認証要求で "scope" 変数が使用された場合、エンタープライズ管理者またはエンタープライズ ユーザーを意味します。

"x-search-text" ヘッダーの下に指定された条件に基づいて検索できます。

パラメーター

名前	キー	必須	型	説明
1 ページあたりのレコード数	recordPerPage	True	integer	ページで取得するレコードの合計数。
取得するページ番号	pageNo	True	integer	取得するページ番号。
列でソート	sort-by		string	上記で説明した値で結果を並べ替えます。
結果セットを並べ替え	asc		boolean	結果セットを昇順または降順で並べ替えます。
テンプレート ID でフィルター処理する	id		array	テンプレート ID で検索します。
テキストを検索する	x-search-text		string	必要に応じてテキストを検索します。 これは省略可能であり、指定しないとリスト全体が返されます。 さらに、検索テキスト パラメーターの推奨値は Base64 でエンコードされた形式です。
レコードの数の合計	x-total-records		string	指定された検索条件で見つかったレコードの合計数。

返品

response

array of EnterpriseTemplateResponse

エンタープライズ パッケージのワークフロー ユーザー認証 (ドキュメントを開く) を取得する

操作 ID:

V4_EnterpriseDocuments_GetEnterpriseWorkflowAccess

ビジネス アプリケーションでは、このサービス API を使用して、パッケージのアクセス セキュリティ設定を有効にすることができます。 セキュリティが構成されている受信者は、URL 内の順序によって識別されます。 パッケージ ID は、要求 URL でも識別されます。 アクセス セキュリティが有効になっている場合、受信者はこの期間の範囲外のドキュメント パッケージにアクセスできません。 ドキュメント所有者は、受信者のパッケージの認証ベースのセキュリティを構成することもできます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ワークフロー アクセスのセキュリティと認証を更新するパッケージ ID。
受信者の順序	order	True	integer	アクセス セキュリティと認証を更新するワークフロー内の受信者の順序。

返品

Body

EnterpriseAccessResponse

ゲートキーパー辞退ドキュメント

操作 ID:

V4_Package_GatekeeperDecline

ビジネス アプリケーションでは、このサービス API を使用して、指定されたユーザーによるドキュメントの拒否を順番にゲートキーパーで行うことができます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	拒否されるパッケージの ID。
理由	reason		string	ユーザーが辞退した理由。

返品

response

object

テキスト ボックス フィールドの追加

操作 ID:

V4_TextBox_AddTextBox

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントにテキスト入力フィールドを追加できます。

この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。

詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
順序	order	True	integer	フィールドが追加されるワークフロー内のユーザーの順序。
page_no	page_no	True	integer	フィールドを作成するページ番号。
型	type	True		フィールドの種類、使用可能な値は "TEXT"、"NAME"、"EMAIL"、"COMPANY"、"JOBTITLE"、"DATE" です。 それ以外のすべてのテキスト フィールドは、受信者の属性/データを使用して、保留中モードで自動的に入力されます。
value	value		string	フィールドの値。 型 = DATE の場合、値は ISO 8601 形式に従う必要があります。YYYY-MM-DD hh:mm:ss +00 の形式に従います。 値は日付フィールドのため、クライアント アプリケーションは YYYY-MM-DD を送信し、hh:mm:ss +00 を無視できます。 値が適切な形式でない場合は、エラーが返されます。
プレースホルダ	placeholder		string	テキスト フィールドのプレースホルダー テキスト。 名前、電子メール、会社、役職、日付のプレースホルダー値には、"NAME"、"EMAIL"、"COMPANY"、"JOBTITLE"、"DATE" を指定できます。 開発者は、独自のプレースホルダーを送信して既定値を上書きできます。 "TEXT" の開発者は、独自のプレースホルダー テキストを提供できます。 これらのプレースホルダーは、ビューアーでドキュメントを表示しているときにテキスト フィールドに表示されます。
max_length (最大長)	max_length	True	integer	フィールドで使用できる値の最大長。 1 ~ 9999 の間
format	format		string	フィールドのテキスト形式。 日付型フィールドにのみ使用されます。 使用可能な値は次のいずれかです: m/d m/d/yy m/d/yyyy mm/dd/yy mm/dd/yyyy mm/yy mm/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d、yyyy dd/mm/yy ddmmmyyyy
field_name	field_name		string	追加するフィールドの名前。 指定しない場合、一意の自動生成された名前がフィールドに割り当てられます。
field_locale	field_locale		string	フィールドローカル。 使用可能な値は ar-AE |en-US. 省略可能で、既定値は en-US。 この値は型 "DATE" に重要です。
field_type	field_type	True		値の型の受け入れに関するフィールド型。使用可能な値は "NUMBER" または "TEXT" です。
validation_rule	validation_rule	True		フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。
入力規則	validation			Validations
フォント	font	True		フィールド テキストのフォント
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。
multiline	multiline	True	boolean	true に設定すると、テキスト領域フィールドが作成されます

返品

Body

AddFieldResponse

テンプレートを取得する

操作 ID:

V4_Settings_GetTemplates

ビジネス アプリケーションでは、このサービス API を使用して、現在のユーザーのテンプレートの一覧を取得できます。

"x-search-text" ヘッダーの下に指定された条件に基づいて検索できます。さらに、エンタープライズ管理者がユーザー ロールに対して許可されているユーザーの個人用テンプレートまたはエンタープライズ テンプレートを検索することもできます。

パラメーター

名前	キー	必須	型	説明
1 ページあたりのレコード数	recordPerPage	True	integer	ページで取得するレコードの合計数。
取得するページ番号	pageNo	True	integer	取得するページ番号。
列でソート	sort-by		string	列で並べ替えます。 指定できる値は、CREATED_ONと NAME です。 既定値はCREATED_ON順に並べ替えられます
Asc	asc		boolean	結果のリストの順序。 結果の既定のリストは降順になります
テキストを検索する	x-search-text		string	必要に応じてテキストを検索します。 これは省略可能であり、指定しないとリスト全体が返されます。 さらに、検索テキスト パラメーターの推奨値は Base64 でエンコードされた形式です。
エンタープライズ テンプレートのみ	x-enterprise		string	"true" に設定すると、エンタープライズ テンプレートの一覧のみが返されます。 "false" の場合は、ユーザーのテンプレート リストのみが返されます。ヘッダーを設定しない場合は、エンタープライズとユーザーの両方のテンプレート リストが返されます。
レコードの数の合計	x-total-records		string	指定された検索条件で見つかったレコードの合計数。

返品

response

array of TemplateResponse

デジタル署名フィールドの更新

操作 ID:

V4_Signature_UpdateSignature

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのデジタル署名フィールドを更新できます。

すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
field_name	field_name	True	string	更新するフィールドの現在の名前。
level_of_assurance	level_of_assurance		array of string	更新される保証レベル。 使用できる値は、"ELECTRONIC_SIGNATURE"、"ELECTRONIC_SEAL"、"ADVANCED_ELECTRONIC_SEAL"、"QUALIFIED_ELECTRONIC_SEAL"、"ADVANCED_ELECTRONIC_SIGNATURE"、"HIGH_TRUST_ADVANCED"、"QUALIFIED_ELECTRONIC_SIGNATURE" です。
renamed_as	renamed_as		string	フィールドの名前を変更する場合は、フィールドの名前を更新しました。
page_no	page_no	True	integer	フィールドを作成するページ番号。
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。
表示	display		string	更新するフィールドの可視性。使用可能な値は "VISIBLE" と "INVISIBLE" です。
authentication_signing	authentication_signing			フィールド認証
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

デジタル署名フィールドの追加

操作 ID:

V4_Signature_AddSignature

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントにデジタル署名フィールドを追加できます。

この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。

詳細については、「 ワークフローへのユーザーの追加 」を参照してください。テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ワークフローの詳細を更新する必要があるパッケージ ID。
ドキュメント ID	documentId	True	integer	フィールドを追加するドキュメント ID。
順序	order	True	integer	フィールドが作成される受信者の順序。
page_no	page_no	True	integer	フィールドが作成されるページ番号。
field_name	field_name		string	追加するフィールドの名前。 指定しない場合、一意の自動生成された名前がフィールドに割り当てられます。
level_of_assurance	level_of_assurance		array of string	追加される保証レベル。 使用できる値は、"ELECTRONIC_SIGNATURE"、"ELECTRONIC_SEAL"、"ADVANCED_ELECTRONIC_SEAL"、"QUALIFIED_ELECTRONIC_SEAL"、"ADVANCED_ELECTRONIC_SIGNATURE"、"HIGH_TRUST_ADVANCED"、"QUALIFIED_ELECTRONIC_SIGNATURE" です。
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。
表示	display		string	追加するフィールドの可視性。使用可能な値は "VISIBLE" と "INVISIBLE" です。
authentication_signing	authentication_signing			フィールド認証

返品

Body

SignatureFieldResponse

ドキュメント パッケージの共有

操作 ID:

V4_Workflow_StartWorkflow

ビジネス アプリケーションでは、このサービス API を使用して、署名者とドキュメント パッケージを共有し、新しいワークフローを開始できます。 テンプレートを適用し、必要に応じてテンプレートで定義されているユーザーとアクションを更新することで、ドキュメントは既に準備されている必要があります。 共有するパッケージ ID は、リソース URL に指定されます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	共有するドキュメント パッケージ。

返品

response

array of StartWorkflowResponse

ドキュメント フィールドの削除

操作 ID:

V4_Fields_DeleteDocumentField

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのフィールドを削除できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
field_name	field_name	True	string	削除するフィールドの名前。

返品

response

object

ドキュメント フィールドの割り当て

操作 ID:

V4_Fields_AutoAssignField

ビジネス アプリケーションでは、このサービス API を使用して、署名フィールドなどの入力フィールドにユーザーを割り当て、署名順序を定義できます。 フィールドはドキュメント内に既に存在している必要があり、ユーザーはワークフローに存在している必要があります。 ワークフロー ドキュメントの ID は、パッケージ識別子と共にリソース URL に指定されます。

受信者がワークフロー内にある場合は、番号が付けられます。番号は 1 から始まり、追加の受信者ごとにカウントされます。したがって、ワークフローに 3 人のユーザーがいる場合は、"1"、"2"、および "3" という番号が付けられます。この API 呼び出しを使用すると、ワークフロー注文番号でユーザーをドキュメントの入力フィールドに割り当てることができます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	ワークフロー ユーザーを更新する必要があるドキュメント ID。
field_name	field_name	True	string	割り当てる署名フィールドの名前。
radio_group_name	radio_group_name		string	ラジオ ボックスのグループ名を指定する
順序	order	True	integer	フィールドが割り当てられているワークフロー内のユーザーの順序。
level_of_assurance	level_of_assurance		array of string	追加される保証レベル。 使用できる値は、"ELECTRONIC_SIGNATURE"、"ELECTRONIC_SEAL"、"ADVANCED_ELECTRONIC_SEAL"、"QUALIFIED_ELECTRONIC_SEAL"、"ADVANCED_ELECTRONIC_SIGNATURE"、"HIGH_TRUST_ADVANCED"、"QUALIFIED_ELECTRONIC_SIGNATURE" です。

返品

response

object

ドキュメント フィールドを取得する

操作 ID:

V4_Fields_GetAllDocumentFields

ビジネス アプリケーションでは、このサービス API を使用して、イニシャル、イン人物、署名フィールド、フォーム フィールドなどのドキュメント フィールドを取得できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージの ID。
ドキュメント ID	documentId	True	integer	フィールドが要求されるドキュメントの ID。
ページいいえ	pageNo	True	integer	フィールドが要求されるドキュメントのページ番号。 ページ番号が指定されていない場合は、ドキュメント全体のフィールドが返されます。
発信者	x-mobile		string	要求/アクションの発信元 (Web/Mobile) を定義する

返品

Body

FieldsResponse

ドキュメントに署名する

操作 ID:

V4_Signing_SignDocument

ビジネス アプリケーションでは、このサービス API を使用して、SigningHub を使用してエンド ユーザーにドキュメントを表示せずにドキュメントに署名できます (電子とデジタルの両方)。 たとえば、ビジネス アプリケーションには、ドキュメントをユーザーに表示する別の方法があり、SigningHub の署名機能のみが必要な場合や、一括操作の場合は、ユーザーがすべてのドキュメントを個別に表示および承認する必要なしに署名することが正当化される場合があります。 署名前にドキュメントに保存する変更がある場合は、署名ドキュメント API を呼び出す前に Fill Form Fields API を呼び出す必要があります。 ドキュメントの必須入力フィールドは、この API が正常に完了する前に完了する必要があることに注意してください。

署名者は、呼び出しで提示されたアクセス トークンによって識別されます。そのため、この呼び出しを行う前に、署名者の 認証 が必要です。スコープ変数を使用してエンタープライズ管理者として認証を行い、ユーザーに代わってドキュメントに署名することはできません。アクセス トークンは、直接認証の結果として署名者に発行する必要があります。

この呼び出しが完了したら、署名者がドキュメントの最後の署名者であった場合、 Finish Document API 呼び出しが呼び出される必要があります。その理由は、その API を呼び出さずにドキュメントがドキュメントの所有者に対して "進行中" の状態のままになるためです。 API が呼び出されると、ドキュメント所有者の状態が "完了" に変わります。

ドキュメントに署名すると、ドキュメント検証 API の 取得から検証 応答が表示されます。

認証の第 1 または第 2 要素 OTP 使用法

サーバー側の署名操作で OTP 認証が有効になっている場合、クライアント アプリケーションは、OTP API 呼び出し による署名者認証 を使用して、モバイル番号の OTP を生成する必要があります。 それぞれのビジネス アプリケーションは、使用から OTP を取得し、API 呼び出しを行うときに送信する必要があります。 これは、要求の "x-otp" ヘッダーを使用して行われます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	署名用のドキュメントを含むパッケージの識別子。
ドキュメント ID	documentId	True	integer	署名するドキュメントの識別子。
field_name	field_name	True	string	ドキュメント内の署名フィールドの一意識別子。
hand_signature_image	hand_signature_image		string	Base64 でエンコードされた、ドキュメントに配置される、表示される署名の外観の文字列イメージ。 これは、この 呼び出しを使用してユーザーの個人設定から取得できることに注意してください。 (応答はバイナリであるため、ビジネス アプリケーションでは、この API 呼び出しで送信する前に Base64 でエンコードする必要があります)。
hand_signature_method	hand_signature_method			署名のユーザーによるハンド 署名メソッドの名前。 ハンド シグネチャ メソッドが指定されていない場合、既定値は DRAW になります。
signing_reason	signing_reason		string	受信者が提供する署名の理由。 注: XML ドキュメントのコミットメントの種類の表示
signing_location	signing_location		string	受信者によって提供される署名者のロケール。
contact_information	contact_information		string	受信者から提供された署名者の連絡先情報。
user_name	user_name		string	受信者が指定した署名者の名前。 これは、対人署名操作にのみ適用されることに注意してください。
user_password	user_password		string	ユーザーが提供するパスワードは、ユーザーの署名設定の対象となります。
appearance_design	appearance_design		string	署名のためにユーザーによって提供される署名の外観の名前。 外観名が指定されていない場合は、既定で選択した外観が使用されます。 指定できる値は、"COMPANY_LOGO"、"DETAILED_SIGNATURE"、"HAND_SIGNATURE" です。
signing_capacity	signing_capacity		string	ドキュメントの署名に使用する認定プロファイル/署名容量の名前。 指定されていない場合は、既定の容量が署名に使用されます。 指定された名前は、大文字と小文字が区別されるため、実際のプロファイルとまったく同じである必要があります。
skip_verification	skip_verification	True	boolean	true に設定されている場合、応答本文では署名検証は返されません。 このパラメーターの既定値は false に設定されます。
signing_server	signing_server		string	ドキュメントの署名に使用する署名サーバーの名前。
認証	authentication			認証オブジェクトは省略可能であり、認証の再指定されたオプションが含まれています
One-Time パスワード (OTP)	x-otp		string	署名操作の第 2 要素認証として使用される OTP。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。
Mobile Originator	x-mobile		string	要求/アクションの発信元 (Web/Mobile) を定義する

返品

Body

SignDocumentResponse

ドキュメントの Certify ポリシーを取得する

操作 ID:

V4_Documents_GetCertifyPolicy

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントの署名の認定設定を取得できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	ダウンロードするドキュメントの ID。

返品

Body

CertifyPolicyResponse

ドキュメントの Certify ポリシーを更新する

操作 ID:

V4_Documents_UpdateCertifyPolicy

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのサーティフィケーション署名設定を更新できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメントの ID。
証明	certify			ドキュメントの設定オブジェクトを認定します。
lock_form_fields	lock_form_fields	True	boolean	True の 場合は、フォーム フィールドは、現在の文書の最後の署名の後にロックされます。

返品

response

object

ドキュメントのアップロード

操作 ID:

V4_Documents_UploadStream

ビジネス アプリケーションでは、このサービス API を使用して、エンタープライズ ユーザーのアカウントにリンクされたドキュメント パッケージにドキュメントを追加できます。 ドキュメント情報は HTTP 要求ヘッダーで送信され、ドキュメント バイトは HTTP 要求本文で送信されます。 注: ヘッダー "x-convert-document" が "true" に設定されている場合、SigningHub はサポートされているドキュメント形式を PDF に変換します。 この値が "false" に設定されている場合にサポートされる唯一のケースは、Word形式と XML ドキュメントを保持することです。

SigningHub では、さまざまなドキュメント形式がサポートされており、アップロード時にそれぞれ PDF 形式に変換できます。完全な一覧については、ここをクリックしてください。

注: PDF ドキュメントは、システムへのアップロード時に変更されません。

この呼び出しを使用してドキュメントを追加するには、パッケージが既に存在している必要があることに注意してください。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントを追加するパッケージのパッケージ ID。
ドキュメント (バイナリ ストリーム)	file (binary Stream)		binary	これは、未加工のバイナリ形式のドキュメントです。
ファイル名	x-file-name		string	拡張子が付いたファイルの名前です。
ドキュメントの変換	x-convert-document		string	これにより、ドキュメントを PDF に変換するか、元の形式で保持する必要があるかが識別されます。 サポートされている唯一の元の形式は現在Wordです。Xml。 このヘッダー値が "false" に設定されている場合、他のすべてのドキュメントの種類ではエラーが発生します。 PDF ドキュメントをアップロードする場合、このヘッダーは省略できます。
Source	x-source		string	これは、ドキュメントのアップロード元のドキュメントのソース ("マイ アプリ" など) の識別です。

返品

Body

UploadDocument

ドキュメントの削除

操作 ID:

V4_Documents_DeleteDocument

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントを削除できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	削除するドキュメントの ID。

返品

Body

DocumentResponse

ドキュメントの取り消し

操作 ID:

V4_Workflow_RecallWorkflow

ビジネス アプリケーションでは、このサービス API を使用して、進行中のワークフローを停止できます。 ドキュメント ID はリソース URL で指定されます。 再呼び出し後、ドキュメントの状態が自動的に "DRAFT" に変わります。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	呼び出すパッケージの ID。

返品

response

object

ドキュメントの名前を変更する

操作 ID:

V4_Documents_RenameDocument

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントの名前を変更できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメントの ID。
document_name	document_name	True	string	ドキュメントの新しい名前。

返品

Body

DocumentResponse

ドキュメントの承認

操作 ID:

V4_Package_Approve

ビジネス アプリケーションでは、このサービス API を使用して、指定されたユーザーによるドキュメントを順番に承認できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	承認されるパッケージの ID。
理由	reason		string	パッケージを承認する理由。
ドキュメント アクセス パスワード	x-password		string	ドキュメントにアクセスするためにドキュメント所有者によって設定されたパスワード (存在する場合)。 パスワードが設定されていない場合、値は null になります。
ドキュメント One-Time パスワード	x-otp		string	ドキュメント所有者がドキュメントにアクセスするために設定した One-Time パスワード (OTP) (存在する場合)。 OTP が設定されていない場合、値は null になります。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

ドキュメントの詳細を取得する

操作 ID:

V4_Documents_GetDocumentDetails

ビジネス アプリケーションでは、このサービス API を使用してドキュメントの詳細を取得できます。 ドキュメント ID は、URL に "{document_id}" として指定されます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	ドキュメントの詳細が要求されるドキュメント ID。
ドキュメント パスワード	x-password		string	ドキュメントにアクセスするためにドキュメント所有者によって設定されたパスワード (存在する場合)。 パスワードが設定されていない場合、値は null になります。
One-Time パスワード (OTP)	x-otp		string	ドキュメント所有者がドキュメントにアクセスするために設定した One-Time パスワード (OTP) (存在する場合)。 OTP が設定されていない場合、値は null になります。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

Body

DocumentDetailsResponse

ドキュメントの辞退

操作 ID:

V4_Package_Decline

ビジネス アプリケーションでは、このサービス API を使用して、指定されたユーザーによるドキュメントを順番に拒否できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	拒否されるパッケージの ID。
理由	reason		string	ユーザーが辞退した理由。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

ドキュメントをダウンロードする

操作 ID:

V4_Documents_DownloadDocumentBytes

ビジネス アプリケーションでは、このサービス API を使用してドキュメント バイトをダウンロードできます。 パッケージ ID とドキュメント ID は、リソース URL で指定されます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	ダウンロードするドキュメントの ID。
ドキュメント パスワード	x-password		string	ドキュメントにアクセスするためにドキュメント所有者によって設定されたパスワード (存在する場合)。 パスワードが設定されていない場合、値は null になります。
One-Time パスワード (OTP)	x-otp		string	ドキュメント所有者がドキュメントにアクセスするために設定した One-Time パスワード (OTP) (存在する場合)。 OTP が設定されていない場合、値は null になります。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

ドキュメントを送信する

操作 ID:

V4_Package_Submit

SigningHub ロールの 1 つは "エディター" と呼ばれます。 これにより、受信者はドキュメントの入力フィールドを編集できますが、署名は必要ありません。 完了すると、受信者は変更を送信します。 GUI で使用されるボタンは、"送信" と呼ばれます。

これは、エディターが API 呼び出しを介して変更を送信する同等の操作です。

使用可能なすべてのワークフロー受信者ロールの説明については、[ SigningHub ロール ] をクリックします。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	送信するドキュメントを含む SigningHub パッケージ ID。
ドキュメント アクセス パスワード	x-password		string	ドキュメントにアクセスするためにドキュメント所有者によって設定されたパスワード (存在する場合)。 パスワードが設定されていない場合、値は null になります。
ドキュメント One-Time パスワード	x-otp		string	ドキュメント所有者がドキュメントにアクセスするために設定した One-Time パスワード (OTP) (存在する場合)。 OTP が設定されていない場合、値は null になります。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

パッケージのダウンロード

操作 ID:

V4_Package_DownloadPackageBytes

ビジネス アプリケーションでは、このサービス API を使用して、バイナリ形式でドキュメント パッケージをダウンロードできます。

パッケージ ID はリソース URL で指定されます。

パッケージに含まれるドキュメントが 1 つだけの場合、ダウンロードはバイナリ PDF ドキュメントです。

または、パッケージに複数のドキュメントがある場合、ダウンロードはすべてのドキュメントのバイナリ zip ファイルです。

x-password ヘッダーと x-otp ヘッダーは省略可能です。 ワークフローの作成フェーズでドキュメント所有者が設定した場合は必須です。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId_bulkAction	True	integer	ダウンロードするパッケージ ID。
ドキュメント ID	document-ids		array	Document ID パラメーターは省略可能です。 x-combine-files が true に設定されている場合、ドキュメントはパッケージの前述のドキュメントに基づいてマージされます。
ドキュメント アクセス パスワード	x-password		string	ドキュメントにアクセスするためにドキュメント所有者によって設定されたパスワード (存在する場合)。 パスワードが設定されていない場合、値は null になります。
ドキュメント One-Time パスワード	x-otp		string	ドキュメント所有者がドキュメントにアクセスするために設定した One-Time パスワード (OTP) (存在する場合)。 OTP が設定されていない場合、値は null になります。
ファイルの結合	x-combine-files		string	既定値は false、"true" に設定すると、ドキュメント パッケージ全体が 1 つの PDF ファイルに結合されます。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

パッケージの一括署名

操作 ID:

V4_Signing_BulkSignDocuments

ビジネス アプリケーションでは、この API を使用して、エンド ユーザーにドキュメントを表示することなく、複数のドキュメント (電子とデジタルの両方) に署名、共有、共有できます。 この API には、ドキュメント パッケージに関するビジネス アプリケーションからの情報と、署名、対人フィールド、イニシャル フィールドの詳細が必要です。 一括署名トランザクションが正常に完了すると、API はドキュメント パッケージの状態とトランザクション ID を返します。

Sign Document API とは異なり、この API はドキュメント パッケージに署名するだけでなく、受信者が署名者、編集者、レビュー担当者のいずれであるかに基づいて承認およびレビュー済みとしてマークします。 状態が COMPLETED として返されるドキュメント パッケージは、この API によって署名、承認、またはレビューされています。

一括署名は、すべての署名時認証方法で機能します。

SIGN がbulk_actionとして渡され、パッケージがドラフト状態の場合、署名と共有が自動的に実行されます。

この API は、 事前一括署名ドキュメント API の後で呼び出す必要があります。

署名する前にドキュメントを変更する必要がある場合は、事前一括署名ドキュメント API を呼び出す前に Fill Form Fields API を呼び出す必要があります。 ドキュメントの必須入力フィールドは、この API が正常に完了する前に完了する必要があります。一方、自動入力されたフィールド (名前、電子メール、日付、役職など) は自動的に入力されます。

署名者は、呼び出しで提示されたアクセス トークンによって識別されます。 そのため、この呼び出しを行う前に、署名者の 認証 が必要です。 スコープ変数を使用してエンタープライズ管理者として認証を行い、ユーザーに代わってドキュメントに署名することはできません。 アクセス トークンは、直接認証の結果として署名者に発行する必要があります。

ドキュメントに署名すると、 一括署名状態 API から確認応答が表示されます。

認証の第 1 または第 2 要素 OTP 使用法

サーバー側の署名操作で OTP 認証が有効になっている場合、クライアント アプリケーションは、OTP API 呼び出し による一括署名認証 を使用して、携帯電話番号の OTP を生成する必要があります。 それぞれのビジネス アプリケーションは、使用から OTP を取得し、API 呼び出しを行うときに送信する必要があります。 これは、要求の "x-otp" ヘッダーを使用して行われます。

パラメーター

名前	キー	必須	型	説明
識別子	ids		array of integer	一括署名用に選択されたドキュメント パッケージ ID の配列。
hand_signature_initials_image	hand_signature_initials_image		string	イニシャルの塗りつぶしに使用される Base64 イメージ
hand_signature_initials_method	hand_signature_initials_method		integer	0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE
hand_signature_image	hand_signature_image		string	Base64 でエンコードされた署名の外観の文字列イメージ
hand_signature_method	hand_signature_method			署名のユーザーによるハンド 署名メソッドの名前。 ハンド シグネチャ メソッドが指定されていない場合、既定値は DRAW になります。 指定できる値 DRAW、TEXT、UPLOAD、SIGNATURE_PAD
signing_reason	signing_reason		string	受信者が提供する署名の理由。
signing_location	signing_location		string	受信者によって提供される署名者のロケール
contact_information	contact_information		string	受信者から提供された署名者の連絡先情報
appearance_design	appearance_design		string	署名のためにユーザーによって提供される署名の外観の名前。 外観名が指定されていない場合は、既定で選択した外観が使用されます。 指定できる値は、"COMPANY_LOGO"、"DETAILED_SIGNATURE"、"HAND_SIGNATURE" です。
signing_server	signing_server		string	ドキュメントの署名に使用する署名サーバーの名前
signing_capacity	signing_capacity		string	ドキュメントの署名に使用する認定プロファイル/署名容量の名前
認証	authentication			認証オブジェクトは省略可能であり、認証の再指定されたオプションが含まれています
取引ID	transaction_id		string	再び開始された署名プロセスのトランザクション ID
パッケージ識別子	packageId_bulkAction	True	string	実行する一括アクション。 使用可能な値は、SIGN |共有
OTP への署名	x-otp		string	署名操作の第 2 要素/ドキュメント署名認証として使用される OTP/TOTP。
ドキュメント アクセス パスワード	x-open-password		string	ドキュメントにアクセスするためにドキュメント所有者によって設定されたパスワード (存在する場合)。 パスワードが設定されていない場合、値は null になります。
ドキュメント One-Time パスワード	x-open-otp		string	ドキュメント所有者がドキュメントにアクセスするために設定した One-Time パスワード (OTP) (存在する場合)。 OTP が設定されていない場合、値は null になります。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。
Mobile Originator	x-mobile		string	要求/アクションの発信元 (Web/Mobile) を定義する

返品

Body

BulkSignResponse

パッケージの削除

操作 ID:

V4_Package_DeletePackage

ビジネス アプリケーションでは、このサービス API を使用して、ユーザーの受信トレイからドキュメントを削除できます。 パッケージ ID は、リソース URL に "{package_id}" として指定されます。 ドキュメントの状態が保留中の場合、削除操作の結果として自動的に拒否されます。 ドキュメントの状態が SHARED の場合、ドキュメントは自動的に取り消され、ドキュメントが削除される前にワークフローが停止されます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId_bulkAction	True	integer	ドキュメントを含むパッケージのパッケージ ID。

返品

response

object

パッケージの詳細を取得する

操作 ID:

V4_Package_GetPackageDetails

ビジネス アプリケーションでは、このサービス API を使用してパッケージの詳細を取得できます。 この API は、ビジネス アプリケーションが "スコープ認証" を介してエンタープライズ ユーザーに代わってアクションを実行するためにも使用できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメント パッケージのパッケージ ID。

返品

Body

GetPackageDetailsResponse

パッケージの追加

操作 ID:

V4_Package_AddPackage

このサービス API は、1 つ以上のドキュメントを保持するドキュメント パッケージを追加または作成するために使用されます。 このパッケージを使用すると、新しいワークフローを開始するためにドキュメントと受信者を追加できます。

前述のように、ドキュメントを操作する場合は、この呼び出しが必須です。 SigningHub にドキュメントをアップロードまたは追加するには、パッケージが存在する必要があります。

1 つのドキュメントでもパッケージの一部です。1 つのドキュメントを含むパッケージです。

注: パッケージは、作成後に必要に応じて名前を変更できます。

パラメーター

名前	キー	必須	型	説明
package_name	package_name		string	パッケージの名前。 package_nameが指定されていない場合、既定のパッケージ名は常に "無題" になります。
workflow_mode	workflow_mode	True		ワークフローのモードは、アプリケーションでサポートされているワークフローモードの3種類があります。 指定できる値は、"ONLY_ME"、"ME_AND_OTHERS"、"ONLY_OTHERS" です。
folder_name	folder_name		string	フォルダーの名前。 カスタム フォルダーまたは共有フォルダーのいずれかであるユーザーの任意のフォルダーにパッケージをアップロードするために使用されます。

返品

Body

AddPackageResponse

パッケージをカスタムフォルダーまたは共有スペースフォルダーに移動する

操作 ID:

V4_Folder_MovePackage

ビジネス アプリケーションでは、このサービス API を使用して、ドキュメント パッケージを共有スペースまたはユーザーのカスタム フォルダーに移動できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	フォルダーに移動する必要があるパッケージ ID
folder_name	folder_name	True	string	パッケージを移動する必要があるターゲット フォルダー名

返品

response

object

パッケージを取得する

操作 ID:

V4_Package_GetAllPackages

ビジネス アプリケーションでは、このサービス API を使用して、さまざまな状態でフィルター処理されたドキュメントの一覧を取得できます。 ユーザーは、1 ページに複数のレコードを指定することで、レコードをページに分割できます。

パラメーター

名前	キー	必須	型	説明
ドキュメントの状態	document_status	True	string	ドキュメントの状態でフィルター処理できる値は、ALL、DRAFT、PENDING、SIGNED、DECLINED、INPROGRESS、EDITED、REVIEWED、COMPLETED、EXPIRING_IN_SEVEN_DAYSです。
ページ番号	pageNo	True	integer	ページ番号。1 ページあたりのレコードの除算に従います。
各ページのレコード	recordPerPage	True	integer	1 つの要求でフェッチする必要があるレコードの数。
パッケージ名	package-name		string	パッケージ名
パッケージ識別子	package-id		integer	パッケージ ID
より	recipient-from		string	より
〜へ	recipient-to		string	〜へ
ドキュメント ID	document-id		integer	ドキュメント ID
有効期限 (日数)	expiry		integer	有効期限 (日数)
変更日から	modified-from		date-time	変更日から
変更日へ	modified-to		date-time	変更日へ
From Size (KB)	size-from		integer	From Size (KB)
To Size (KB)	size-to		integer	To Size (KB)
認定済みドキュメント	certified-documents		boolean	認定済みの署名済みドキュメントのみ
フォーム フィールド	form-fields		boolean	フォーム フィールドがあるドキュメントのみ
添付ファイル	attachments		boolean	添付ファイルを含むドキュメントのみ
ドキュメントの種類	document-type		string	XML、PDF、DOCX などのドキュメントの種類
並べ替え順	sort-by		string	選択に従って結果レコードを並べ替える
昇順	asc		boolean	結果のレコードを昇順または降順で並べ替えた
ドキュメントの状態	document-statuses		array	ドキュメントの種類
所有者	owned-by		string	所有フィルターで指定できる値は、ME_OTHERS、ME、OTHERS です。
スマート フォーム名	smart-form		string	スマート フォーム名
フォルダー名	x-folder		string	ドキュメントがフェッチされるフォルダー名。 指定できる値は INBOX と ARCHIVE. です。さらに、x-folder パラメーターの推奨値は Base64 でエンコードされた形式です。
テキストの検索	x-search-text		string	ヘッダーで送信されたテキストを検索して、ドキュメントをさらにフィルター処理します。 パッケージ ID、名前、ドキュメント所有者を検索できます。 さらに、検索テキスト パラメーターの推奨値は Base64 でエンコードされた形式です。
合計レコード数	x-total-records		string	指定された検索条件で見つかったレコードの合計数。
Source	x-source		string	これは、ドキュメントのアップロード元のドキュメントのソース ("マイ アプリ" など) の識別です。
受信者の詳細	x-recipient-details		string	"true" が渡された場合、ドキュメント アクセス期間に関する受信者の詳細が拒否情報と共に提供されます

返品

response

array of GetPackagesResponse

パッケージ名の変更

操作 ID:

V4_Package_RenamePackage

このサービス API は、ドキュメント パッケージの名前を変更するために使用されます。

ドキュメント パッケージは、呼び出しの URL 内の一意の識別子によって識別されます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId_bulkAction	True	integer	名前を変更するパッケージ ID。
package_name	package_name	True	string	ドキュメント パッケージの新しい名前。

返品

response

object

フォーム フィールドの入力

操作 ID:

V4_Fields_FillFormFields

ビジネス アプリケーションでは、このサービス API を使用して、指定したユーザーがドキュメント内の 1 つ以上のフォーム フィールドに順番に入力できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	ドキュメントの ID。
auto_save	auto_save	True	boolean	既定値は false です。 True の 場合、フォーム フィールドがユーザーの介入なしで保存されている場合 (たとえば、ドキュメントを閉じたり、戻るキーを押したりします)。 署名、イニシャル、個人、レビュー、送信アクションの場合、値は false です。
field_name	field_name	True	string	ドキュメント内のフィールドの一意識別子。
value	value		string	ドキュメントに保存するフィールドの値。
field_name	field_name	True	string	ドキュメント内のフィールドの一意識別子。
radio_group_name	radio_group_name		string	ラジオ ボタンが属するグループ名。
value	value	True	boolean	ドキュメントに保存するフィールドの値。
field_name	field_name	True	string	ドキュメント内のフィールドの一意識別子。
value	value	True	boolean	ドキュメントに保存するフィールドの値。
field_name	field_name	True	string	ドキュメント内のフィールドの一意識別子。
value	value		string	ドキュメントに保存するフィールドの値。
field_name	field_name	True	string	ドキュメント内のフィールドの一意識別子。
value	value		string	ドキュメントに保存するフィールドの値。
ドキュメント パスワード	x-password		string	ドキュメントにアクセスするためにドキュメント所有者によって設定されたパスワード (存在する場合)。 パスワードが設定されていない場合、値は null になります。
One-Time パスワード (OTP)	x-otp		string	ドキュメント所有者がドキュメントにアクセスするために設定した One-Time パスワード (OTP) (存在する場合)。 OTP が設定されていない場合、値は null になります。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

プレースホルダーの更新

操作 ID:

V4_Workflow_WorkflowUpdatePlaceholder

ビジネス アプリケーションでは、このサービス API を使用して、ワークフロー内のプレースホルダーを更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用され、ビジネス アプリケーションがワークフロー内の特定の場所所有者の詳細をオーバーライドする場合に便利です。 ワークフロー ドキュメントの ID はリソース URL で指定され、ワークフローの場所の所有者はワークフローに追加される順序によって識別されます。 XML 型ドキュメントの準備中、サポートされているロールの種類は "SIGNER"、"REVIEWER"、"CARBON_COPY" のみです。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	プレースホルダーを追加するパッケージの ID。
注文	order	True	integer	ワークフロー内の受信者の順序。
プレースホルダ	placeholder		string	ワークフローに追加する新しいプレースホルダーの名前。 値が指定されていない場合、古い値は保持されます。
email_notification	email_notification		boolean	その値を "true" に設定すると、ワークフローにターンが到着すると、電子メール通知がユーザーに送信されます。 値を "false" に設定しても、ユーザーのターンで電子メール通知は送信されません。 値が指定されていない場合、古い値は保持されます。
ロール	role	True		ワークフローの受信者としてのグループの役割。 指定できる値は、"SIGNER"、"REVIEWER"、"EDITOR"、"CARBON_COPY"、"INPERSON_HOST" です。 値が指定されていない場合、古い値は保持されます。 ただし、XML 型のドキュメントの準備では、サポートされているロールの種類は "SIGNER"、"REVIEWER"、"CARBON_COPY" のみです。
signing_order	signing_order		integer	ワークフローが受信者によって署名される順序。 この署名順序は、ワークフローの種類が "CUSTOM" に設定されている場合に重要です。

返品

response

object

プロセス証拠レポートの取得

操作 ID:

V4_WorkflowEvidenceReport_DownloadBytes

ビジネス アプリケーションでは、このサービス API を使用して、ドキュメントのワークフロー プロセス証拠レポートをダウンロードできます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントの ID。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

ライブラリからドキュメントを追加または更新する

操作 ID:

V4_Documents_UploadFromLibrary

ビジネス アプリケーションでは、このサービス API を使用して、ユーザーのライブラリからパッケージにドキュメントを追加できます。 パッケージ ID は URL で指定されます。ドキュメントの ID は、コピーするライブラリ ドキュメントを識別するために、リソース URL に "document_id" として指定する必要もあります。

この呼び出しを使用してドキュメントを追加するには、パッケージが既に存在している必要があることに注意してください。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントを追加するパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	追加/更新が必要なライブラリ ドキュメント ID
古いドキュメント ID	x-document-id		string	更新する必要がある現在のパッケージの古いドキュメントの ID

返品

Body

UploadDocumentLibraryResponse

ワークフロー テンプレートの適用

操作 ID:

V4_Workflow_ApplyTemplate

ビジネス アプリケーションでは、このサービス API を使用して、ワークフロー テンプレートをドキュメントに適用できます。 テンプレートを適用する必要があるドキュメント ID は、リソース URL に指定されます。 ドキュメント ID を 0 に設定すると、pacakge 内のすべての文書にテンプレートが適用されます。

テンプレートを適用する際には、次の 2 つの重要な点を覚えておく必要があります。

ポイント 1 - 既にフォーム フィールドが含まれている PDF を使用して適用するテンプレートを作成する場合は、このテンプレートが適用されているドキュメントに事前にこれらのフォーム フィールドが含まれている必要があることを確認します。SigningHub では、フォーム データのみを適用して、それぞれのユーザーに割り当てるのではなく、テンプレートを使用してこれらのフォーム フィールドを作成しません。

ポイント 2 - フォーム フィールドが署名Hub を介して手動で追加される (したがって、もともと PDF に存在しない) 場所に適用されているテンプレートが作成された場合 (署名フィールド、初期、直接署名、チェック ボックス、ラジオ ボタン、テキスト フィールドなど)、そのようなテンプレートを適用すると、これらのフォーム フィールドが文書に既に存在していた場合でも、対象のドキュメントにこれらのフォーム フィールドが作成されます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	テンプレートを適用する必要があるパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	テンプレートを適用する必要があるドキュメント ID。 値が 0 に設定されている場合、テンプレートをパッケージ内のすべてのドキュメントに適用する場合。
template_name	template_name	True	string	ドキュメントに適用するテンプレートの名前。
apply_to_all	apply_to_all	True	boolean	True の 場合、テンプレートは、パッケージ内のすべてのドキュメントに適用されます。

返品

Body

DocumentDetailsResponse

ワークフロー ユーザーのアクセス許可を取得する

操作 ID:

V4_WorkflowPermission_GetWorkflowPermissions

ビジネス アプリケーションでは、このサービス API を使用して、受信者のドキュメントアクセス許可を取得できます。 受信者は、ワークフロー内の順序によって識別されます。 パッケージの ID はリソース URL で指定されます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ワークフロー ユーザーを更新する必要があるドキュメント ID。
注文	order	True	integer	アクセス許可が要求されるワークフロー内のユーザーの順序。 値 0 を順番に指定すると、サービスはワークフローで最近追加されたコラボレーターのアクセス許可を返します。

返品

Body

WorkflowPermissionResponse

ワークフロー ユーザーのアクセス許可を更新する

操作 ID:

V4_WorkflowPermission_UpdateWorkflowPermissions

ビジネス アプリケーションでは、このサービス API を使用して、ワークフローに既に追加されているユーザーのワークフローアクセス許可を更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用され、ビジネス アプリケーションがワークフロー内のアクセス許可をオーバーライドする場合に便利です。 ドキュメント パッケージの ID はリソース URL で指定され、ワークフロー ユーザーはワークフローに追加された順序で識別されます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ワークフローのアクセス許可を更新するパッケージ ID。
注文	order	True	integer	ワークフローのアクセス許可を更新する受信者の順序。
apply_to_all	apply_to_all	True	boolean	True の 場合は、ワークフロー内のすべての受信者にアクセス許可を適用します。
アクセス許可	permissions	True		これには、ワークフローで許可されるすべてのアクセス許可があります
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

ワークフロー ユーザーの削除

操作 ID:

V4_Workflow_WorkflowDeleteUser

ビジネス アプリケーションでは、このサービス API を使用してワークフロー受信者を削除できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	受信者が削除されるパッケージ ID。
注文	order	True	integer	削除するワークフロー内の受信者の順序。

返品

response

object

ワークフロー ユーザーの取得

操作 ID:

V4_Workflow_GetWorkflowUsers

ビジネス アプリケーションでは、このサービス API を使用して、パッケージのワークフローの詳細を取得できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ダウンロードするパッケージの ID。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

array of WorkflowRecipient

ワークフロー ユーザーの更新

操作 ID:

V4_Workflow_WorkflowUserUpdate

ビジネス アプリケーションでは、このサービス API を使用して、ワークフローに既に追加されている受信者、グループ、または場所所有者の詳細を更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用され、ビジネス アプリケーションがワークフロー内の特定のユーザーの詳細をオーバーライドする場合に便利です。 ワークフロー ドキュメントの ID はリソース URL で指定され、ワークフロー受信者はワークフローに追加される順序で識別されます。 XML 型のドキュメントの準備では、ロールの種類 "SIGNER"、"REVIEWER"、"CARBON_COPY" のみがサポートされることに注意してください。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ワークフロー ユーザーを更新する必要があるパッケージ ID。
注文	order	True	integer	ワークフロー内のユーザーの順序。
user_email	user_email		string	ワークフローで更新する新しいユーザーの電子メール アドレス。 値が指定されていない場合、古い値は保持されます。
user_name	user_name		string	更新する受信者の名前。 値が指定されていない場合、古い値は保持されます。
email_notification	email_notification		boolean	その値を "true" に設定すると、ワークフローにターンが到着すると、電子メール通知がユーザーに送信されます。 値を "false" に設定しても、ユーザーのターンで電子メール通知は送信されません。 値が指定されていない場合、古い値は保持されます。
mobile_number	mobile_number		string	携帯電話番号。 値が指定されていない場合、古い値は保持されます。
ロール	role	True		更新する受信者の役割。 指定できる値は、"SIGNER"、"REVIEWER"、"EDITOR"、"CARBON_COPY"、または "INPERSON_HOST" です。 値が指定されていない場合、古い値は保持されます。 ただし、XML 型のドキュメントの準備では、サポートされているロールの種類は "SIGNER"、"REVIEWER"、"CARBON_COPY" のみです。
signing_order	signing_order		integer	ワークフローが受信者によって署名される順序。 この署名順序は、ワークフローの種類が "CUSTOM" に設定されている場合に重要です。
email_language_code	email_language_code		string	電子メール言語コード
delivery_method	delivery_method	True		ワークフロー内の受信者の配信方法。 指定できる値は、"EMAIL"、"SMS"、または "EMAIL_AND_SMS" です。 既定値は EMAIL です
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

Body

UpdateCollaboratorResponse

ワークフロー ユーザーの順序を更新する

操作 ID:

V4_Workflow_WorkflowUserUpdateOrder

ビジネス アプリケーションでは、このサービス API を使用して、ワークフロー内の受信者の順序を更新できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	受信者が追加されるパッケージの ID。
注文	order	True	integer	更新する受信者の既存の順序。
順序	order	True	integer	更新する受信者の順序。

返品

response

object

ワークフロー リマインダーの更新

操作 ID:

V4_Workflow_UpdateWorkflowReminder

ビジネス アプリケーションでは、このサービス API を使用して、ワークフローに既に追加されている受信者のワークフロー アラームを更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用され、ビジネス アプリケーションがワークフロー内のアラーム設定をオーバーライドする場合に便利です。 ワークフロー ドキュメントの ID はリソース URL で指定され、ワークフロー受信者はワークフローに追加される順序で識別されます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ワークフローアラームを更新するパッケージ ID。
注文	order	True	integer	ワークフローアラームを更新するユーザーの順序。
apply_to_all	apply_to_all	True	boolean	True の 場合は、ワークフロー内のすべての受信者にアラーム設定を適用します。
enabled	enabled	True	boolean	True の 場合、アラーム設定を有効にします。
周波数	frequency		string	アラームの頻度。 使用可能な値は DAYS |時間。
remind_after	remind_after	True	integer	必須。有効なプロパティの場合は true になります。 最初のアラームがワークフロー ユーザーに送信される日数。
繰り返す	repeat			アラームはユーザーに繰り返し送信されます。

返品

response

object

ワークフロー リマインダーを取得する

操作 ID:

V4_Workflow_GetWorkflowReminder

ビジネス アプリケーションでは、このサービス API を使用して、ワークフローに既に追加されている受信者のアラームを更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用され、ビジネス アプリケーションがワークフロー内のアラーム設定をオーバーライドする場合に便利です。 ワークフロー ドキュメントの ID はリソース URL で指定され、ワークフロー受信者はワークフローに追加される順序で識別されます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ワークフローアラームを更新するパッケージ ID。
注文	order	True	integer	ワークフローアラームを更新するユーザーの順序。

返品

Body

ReminderResponse

ワークフローにグループを追加する

操作 ID:

V4_Workflow_WorkflowAddGroup

ビジネス アプリケーションでは、このサービス API を使用して、グループを受信者としてワークフローに追加できます。 SigningHub グループは、グループのすべてのメンバーに代わってアクション (つまり、署名) を実行できることを意味します。

グループがワークフローの最後のユーザーまたはグループとして追加されることに注意してください。そのため、ワークフローに既に存在する現在のユーザー/グループを削除するには、さらに作業が必要になる場合があります。 XML 型ドキュメントの準備中、サポートされているロールの種類は "SIGNER"、"REVIEWER"、"CARBON_COPY" のみです。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	グループを追加するパッケージの ID。
グループ名	group_name		string	ワークフローに追加する新しいグループの名前。
email_notification	email_notification	True	boolean	その値を "true" に設定すると、ワークフローにターンが到着すると、電子メール通知がユーザーに送信されます。 値を "false" に設定しても、ユーザーのターンで電子メール通知は送信されません。 値が指定されていない場合は、既定値 "true" が設定されます。
ロール	role	True		ワークフローの受信者としてのグループの役割。 指定できる値は、"SIGNER"、"REVIEWER"、"EDITOR"、"CARBON_COPY"、"INPERSON_HOST" です。 ただし、XML 型のドキュメントの準備では、サポートされているロールの種類は "SIGNER"、"REVIEWER"、"CARBON_COPY" のみです。
signing_order	signing_order		integer	ワークフローが受信者によって署名される順序。 この署名順序は、ワークフローの種類が "CUSTOM" に設定されている場合に重要です。

返品

response

array of CollaboratorGroupResponse

ワークフローにプレースホルダーを追加する

操作 ID:

V4_Workflow_WorkflowAddPlaceholder

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のワークフローにプレースホルダーを追加できます。 ワークフロー内の目的の受信者の ID がわからない場合は、場所の所有者が必要です。

プレースホルダーは、ワークフローの最後のユーザーとして追加されることに注意してください。そのため、ワークフローに既に存在する現在のユーザー/グループを削除するには、さらに作業が必要になる場合があります。

プレース ホルダーを追加すると、ドキュメントに署名や入力フィールドを追加し、後の段階で個々のユーザーに割り当てることができます。 XML 型ドキュメントの準備中、サポートされているロールの種類は "SIGNER"、"REVIEWER"、"CARBON_COPY" のみです。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	プレースホルダーを追加するパッケージの ID。
プレースホルダ	placeholder		string	ワークフローに追加する新しいプレースホルダーの名前。
email_notification	email_notification	True	boolean	その値を "true" に設定すると、ワークフローにターンが到着すると、電子メール通知がユーザーに送信されます。 値を "false" に設定しても、ユーザーのターンで電子メール通知は送信されません。
ロール	role	True		ワークフローの受信者としてのグループの役割。 指定できる値は、"SIGNER"、"REVIEWER"、"EDITOR"、"CARBON_COPY"、"INPERSON_HOST" です。 ただし、XML 型のドキュメントの準備では、サポートされているロールの種類は "SIGNER"、"REVIEWER"、"CARBON_COPY" のみです。
signing_order	signing_order		integer	ワークフローが受信者によって署名される順序。 この署名順序は、ワークフローの種類が "CUSTOM" に設定されている場合に重要です。

返品

response

array of CollaboratorPlaceholderResponse

ワークフローにユーザーを追加する

操作 ID:

V4_Workflow_WorkflowAddUser

ビジネス アプリケーションでは、このサービス API を使用して、ワークフローに受信者を追加できます。 この呼び出しでは、ワークフローに受信者のみが追加されます。 つまり、現在ドキュメント上のフィールドは新しい受信者に自動的に割り当てられず、新しいフィールドも作成されません。

受信者がワークフローの最後のユーザーとして追加されることに注意してください。そのため、ワークフローに既に存在する現在の受信者を削除するには、さらに作業が必要になる場合があります。

フィールド (入力と署名) をドキュメントに追加するには、ワークフローに少なくとも 1 人のユーザーが存在している必要があります。

入力は、1 回の呼び出しで 1 人以上のユーザーを受け入れることに注意してください。

この特定の呼び出しでは、ユーザーは既知の自然人です。 ただし、グループとプレースホルダーにも同じルールが適用されます。 いずれの場合も、受信者はユーザーのグループになり、グループのメンバーはドキュメントに署名できます。プレースホルダーです。後者のケースは、意図した署名者の ID がわからない場合に使用されます。

注: SigningHub ワークフロー署名順序は "1" から始まります。 そのため、現在の受信者がいないワークフローにユーザーを追加すると、新しい署名注文数が開始されます。ワークフローの種類が "カスタム" の場合、"signing_order" パラメーターは必須です。

重要:この API 呼び出しを使用すると、ワークフローの種類に影響する可能性があります。シーケンシャル ワークフローに現在の受信者が存在し、現在の受信者と同じ署名順序で新しい受信者が追加された場合、ワークフローのその部分は順番に自動的に変更されます。そのため、ワークフロー全体は、純粋にシーケンシャルではなく、カスタム型になりました。 2 人または並列の受信者と同じ署名順序を持つ受信者を追加しても、ワークフローは変更されません。ワークフローの特定の時点には、単に 3 人以上の受信者がいます。すべて並列順に表示されます。

XML 型ドキュメントの準備では、サポートされているロールの種類は "SIGNER"、"REVIEWER"、および "CARBON_COPY" であることに注意してください。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	受信者が追加される SigningHub パッケージ ID。
user_email	user_email		string	ワークフローに追加するユーザーの電子メール アドレス。
user_name	user_name	True	string	ワークフローに追加する受信者の名前。
user_national_id	user_national_id		string	受信者のユーザーの国 ID
email_notification	email_notification	True	boolean	true に設定すると、SigningHub はドキュメント所有者とユーザー通知設定に従って電子メールでユーザーに通知を送信します。 false の値は、ワークフロー全体を通じてユーザーに通知が送信されることを意味します。
ロール	role	True		ワークフロー内の受信者のロール。 指定できる値は、"SIGNER"、"REVIEWER"、"EDITOR"、"CARBON_COPY"、または "INPERSON_HOST" です。 ただし、XML 型のドキュメントの準備では、サポートされているロールの種類は "SIGNER"、"REVIEWER"、"CARBON_COPY" のみです。
signing_order	signing_order		integer	ワークフロー内の受信者の順序。 ワークフローの種類が "CUSTOM" の場合、この署名順序は必須です。
delivery_method	delivery_method	True		ワークフロー内の受信者の配信方法。 指定できる値は、"EMAIL"、"SMS"、または "EMAIL_AND_SMS" です。 既定値は EMAIL です
mobile_number	mobile_number		string	携帯電話番号

返品

response

array of CollaboratorResponse

ワークフローの詳細を取得する

操作 ID:

V4_Workflow_GetWorkflowDetail

ビジネス アプリケーションでは、このサービス API を使用して、パッケージのワークフローの詳細を取得できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ダウンロードするパッケージの ID。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

Body

WorkflowDetailsResponse

ワークフローの詳細を更新する

操作 ID:

V4_Workflow_UpdateWorkflow

ビジネス アプリケーションでは、このサービス API を使用してワークフローの詳細を更新できます。 通常、この呼び出しは、テンプレートがドキュメントに適用された後に役立ちますが、ビジネス アプリケーションは認定のアクセス許可または処理後の詳細をオーバーライドする必要があります。 パッケージ ID はリソース URL で指定されます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ワークフローの詳細を更新する必要があるパッケージ ID。
workflow_type	workflow_type			パッケージのワークフローの種類 (SERIAL、PARALLEL、INDIVIDUAL、CUSTOM など)。 値が指定されていない場合、古い値は保持されます。
workflow_mode	workflow_mode			パッケージのワークフロー モード (ONLY_ME、ME_AND_OTHERS、ONLY_OTHERSなど)。 ワークフロー モードが ONLY_ME に設定されている場合、他の認証されたユーザー自体をパッケージ化するためにコラボレーターを追加することはできません
continue_on_decline	continue_on_decline		boolean	True の 場合、受信者がドキュメントを辞退した場合でもワークフローを続行する必要があります。 値が指定されていない場合、古い値は保持されます。
メッセージ	message		string	ドキュメント所有者からすべての受信者へのカスタム文字列メッセージ。このメッセージは、共有メールと画面に表示されます。 値が指定されていない場合、古い値は保持されます。
comments	comments		boolean	コメントを許可する

返品

response

object

ワークフロー履歴を取得する

操作 ID:

V4_Workflow_GetWorkflowHistory

ビジネス アプリケーションでは、このサービス API を使用して、ドキュメントに対して実行されたアクションの一覧を取得できます。 パッケージ ID はリソース URL で指定されます。 検索フィールド (x-search-text ヘッダー) は、電子メール、ドキュメント名、アクション、infokey、infovalue を対象としています。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ログが必要なドキュメントの ID。
ページ番号	pageNo	True	integer	取得するページ番号。
各ページのレコード	recordsPerPage	True	integer	ページで取得するレコードの合計数。
テキストの検索	x-search-text		string	検索フィールド (x-search-text ヘッダー) は、電子メール、ドキュメント名、アクション、infokey、infovalue を対象としています。

返品

Body

WorkflowHistoryResponse

一括署名の状態

操作 ID:

V4_Signing_BulkSignStatus

ビジネス アプリケーションでは、この API を使用して、一括署名パッケージ API によって処理されたドキュメント パッケージの詳細と共に、特定の 一括署名 トランザクションの状態を取得できます。

この API は、一括署名パッケージ API の後で呼び出す必要があります。

署名者は、呼び出しで提示されたアクセス トークンによって識別されます。 そのため、この呼び出しを行う前に、署名者の 認証 が必要です。 スコープ変数を使用してエンタープライズ管理者として認証を行い、ユーザーに代わってドキュメントに署名することはできません。 アクセス トークンは、直接認証の結果として署名者に発行する必要があります。

RAS 署名の場合、ACTION プロパティはREMOTE_AUTHORIZATION_REQURIEDされ、STATUS プロパティは保留中になり、モバイル デバイスを使用して要求を承認する必要があることを示します。 構成されている保証レベルが異なるために一部のドキュメントで署名プロセスが失敗し、ユーザーが失敗したドキュメントの署名プロセスを完了するために署名プロセスを再開する必要がある場合、ACTION プロパティはREINITIATE_SIGNING_PROCESSされ、STATUS プロパティは保留中になります。

パラメーター

名前	キー	必須	型	説明
取引ID	transaction_id		string	一括署名トランザクションの ID 番号
一括アクション	bulk_action	True	string	実行する一括アクション。 使用可能な値は、SIGN |共有

返品

Body

BulkSignStatusResponse

中央の完全なワークフロー (ワークフローの終了)

操作 ID:

V4_Workflow_MarkWorkflowCompleted

ビジネス アプリケーションは、ワークフローの途中でもワークフローを完了済みとしてマークできます。 このサービス API を使用して、ワークフローの状態を完了に変更します。 まだドキュメントに署名していない受信者がいる場合。 署名はこれ以上必要なく、それ以上受信トレイにドキュメントを表示できなくなります。 ベアラー トークンはドキュメント所有者に属している必要があります。または、エンタープライズ管理者はスコープ変数を使用して、ドキュメント所有者に代わってアクセス トークンを取得してこのアクションを実行できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	受信者が削除されるパッケージ ID。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

個人フィールドの更新

操作 ID:

V4_InPerson_UpdateInPerson

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントの対人署名フィールドを更新できます。

すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
field_name	field_name	True	string	更新するフィールドの現在の名前。
renamed_as	renamed_as		string	名前を変更する場合は、フィールドの更新された名前。
page_no	page_no	True	integer	フィールドを作成するページ番号。
プレースホルダ	placeholder		string	対人フィールドの文字列識別子。Customer、Jack、CEO などです。
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。
表示	display		string	更新するフィールドの可視性。使用可能な値は "VISIBLE" と "INVISIBLE" です。
level_of_assurance	level_of_assurance		array of string	更新される保証レベル。 指定できる値は、"ELECTRONIC_SEAL"、"ADVANCED_ELECTRONIC_SEAL"、"QUALIFIED_ELECTRONIC_SEAL"、"ELECTRONIC_SIGNATURE" です。
authentication_signing	authentication_signing			フィールド認証
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

個人フィールドの追加

操作 ID:

V4_InPerson_AddInPerson

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントに対してユーザー署名フィールドを追加できます。

この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。

詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。

直接会議を開催するには、SigningHub ユーザーがワークフローの一部である必要があります。ロール "INPERSON_HOST" または "SIGNER" を使用して追加する必要があります。 ホスト オプションでは、ドキュメントに署名または入力フィールドは必要ありません。また、署名Hub 以外の登録済みユーザーは、そのユーザーの署名フィールドに署名できます。

これは、SigningHub ユーザーと受信者が同じ場所に存在することが予想される特別なワークフロー シナリオであることに注意してください。この種類の署名は、通常の緩やかな統合方法で電子メール リンクを介してドキュメントを受信者と共有する使用を意図していません。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
順序	order	True	integer	フィールドが追加されるワークフロー内のユーザーの順序。
page_no	page_no	True	integer	フィールドを作成するページ番号。
field_name	field_name		string	追加するフィールドの名前。 指定しない場合、一意の自動生成された名前がフィールドに割り当てられます。
プレースホルダ	placeholder	True	string	対人フィールドの文字列識別子。Customer、Jack、CEO などです。
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。
表示	display		string	追加するフィールドの可視性。使用可能な値は "VISIBLE" と "INVISIBLE" です。
level_of_assurance	level_of_assurance		array of string	更新される保証レベル。 指定できる値は、"ELECTRONIC_SEAL"、"ADVANCED_ELECTRONIC_SEAL"、"QUALIFIED_ELECTRONIC_SEAL"、"ELECTRONIC_SIGNATURE" です。
authentication_signing	authentication_signing			フィールド認証

返品

Body

AddFieldResponse

共有領域の削除

操作 ID:

V4_WorkSpace_DeleteSharedSpace

ビジネス アプリケーションでは、このサービス API を使用して共有領域を削除できます。 共有スペースを削除できるかどうかは、割り当てられたエンタープライズ ユーザー ロールの対象となります。 このプロビジョニングを許可するには、エンタープライズ管理者はロール>Document 設定で [共有領域の管理] オプションを有効にします。

パラメーター

名前	キー	必須	型	説明
共有領域 ID	id	True	integer	削除する共有領域の ID

返品

response

object

共有領域の更新

操作 ID:

V4_WorkSpace_UpdateSharedSpace

ビジネス アプリケーションでは、このサービス API を使用して共有領域を更新できます。 共有スペースの更新の可用性は、割り当てられたエンタープライズ ユーザー ロールの対象となります。 このプロビジョニングを許可するには、エンタープライズ管理者はロール>Document 設定で [共有領域の管理] オプションを有効にします。

パラメーター

名前	キー	必須	型	説明
共有領域 ID	id	True	integer	更新する共有領域の ID
名前	name		string	共有領域の名前
名前	name	True	string	作業スペース・メンバーの名前
メール	email	True	string	作業領域メンバーの電子メール アドレス

返品

response

object

共有領域を取得する

操作 ID:

V4_WorkSpace_GetSharedSpace

ビジネス アプリケーションでは、このサービス API を使用して特定の共有領域を取得できます。 この API は、共有スペース、その所有者、コラボレーターに関する情報を返します。

パラメーター

名前	キー	必須	型	説明
共有領域 ID	id	True	integer	取得する共有領域の ID

返品

Body

WorkSpaceResponse

処理の完了

操作 ID:

V4_Package_Finish

ビジネス アプリケーションでは、このサービス API を使用して、すべての署名フィールドに署名した後にドキュメント処理を完了できます。 この方法は、主に iOS および Android 用のネイティブの SigningHub モバイル アプリと、モバイル Web ユース ケースで使用されます。 それぞれのポータルへの緊密な統合を採用する一般的なビジネス アプリケーションでは、このメソッドを呼び出す必要はありません。 ただし、Sign Document API を使用する場合 (そのため、ユーザーは署名を要求されたドキュメントの視覚的表現を表示されません)、それぞれのワークフローが続行または完了するように、この API を呼び出す必要があります。 たとえば、"ブラインド" 署名ドキュメント API 呼び出しを使用してすべての署名が適用されると、この API が呼び出されるまで、ドキュメントは所有者に "完了" 状態として表示されません。 この API が呼び出されるまで、ドキュメント所有者に "処理中" という状態が表示されます。

ネイティブの SigningHub モバイル アプリとモバイル Web ユース ケース内では、この呼び出しは、各ユーザーが SigningHub に関してそれぞれのアクションを確実に完了するために必要です。たとえば、署名者が SigningHub App でドキュメントに署名した後、このメソッドがアプリケーションによって呼び出され、ワークフローが引き続き処理され、次の署名者に通知されます。 およびドキュメントの状態は、構成されたコールバック URL を介して使用できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	完了するパッケージの ID。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

処理後の更新

操作 ID:

V4_Workflow_UpdateWorkflowPostProcess

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのワークフローにプレースホルダーを追加できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	後処理が更新されるドキュメント パッケージの ID。
enabled	enabled	True	boolean	True の 場合、パッケージの後処理が有効になっています。
contacts	contacts		array of string
名前	name	True	string
メール	email	True	string
メッセージ	message		string	すべての連絡先のカスタム文字列メッセージ。 メッセージは、連絡先に送信された電子メールの一部になります。
google_drive	google_drive		boolean	True の 場合、ワークフローの完了後に指定された Google アカウントにドキュメントをアップロードします。
Dropbox	dropbox		boolean	True の 場合、ワークフローの完了後に指定された Dropbox アカウントにドキュメントをアップロードします。
onedrive	onedrive		boolean	True の 場合は、ワークフローの完了後に指定された oneDrive アカウントにドキュメントをアップロードします。
workflow_recipients	workflow_recipients	True	boolean	True の 場合、ワークフロー完了レポートは、後処理の実行時にワークフローのすべての受信者に送信されます。 既定値は false です。
document_processing_report	document_processing_report	True	boolean	True の 場合、ワークフローに対してドキュメント処理レポート (XML) の送信を有効にする

返品

response

object

初期フィールドの更新

操作 ID:

V4_Initials_UpdateInitial

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントのイニシャル フィールドを更新できます。

すべての入力パラメーターを変更できることに注意してください。現在の設定を保持する場所を変更せずに通話で送信します。

そのため、入力フィールドを追加したときと同じパラメーター、またはドキュメント フィールドの 取得で返される情報を使用できます。後者は、テンプレートが適用されたとき、または GUI インターフェイスを使用してドキュメントが作成されたときに使用できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
field_name	field_name	True	string	更新するフィールドの現在の名前。
renamed_as	renamed_as		string	名前の変更が意図されている場合は、フィールドの名前を更新しました。
page_no	page_no	True	integer	フィールドを作成するページ番号。
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。

返品

response

object

初期フィールドの追加

操作 ID:

V4_Initials_AddInitial

ビジネス アプリケーションでは、このサービス API を使用して、パッケージ内のドキュメントにイニシャル フィールドを追加できます。

この方法でフィールド (入力と署名) をドキュメントに追加するには、少なくとも 1 人のユーザーがワークフローに存在している必要があります。注文番号は、ワークフローの受信者に対応します。したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。

詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	アクションを実行するドキュメント ID。
順序	order	True	integer	フィールドが追加されるワークフロー内のユーザーの順序。
page_no	page_no	True	integer	フィールドを作成するページ番号。
field_name	field_name		string	追加するフィールドの名前。 指定しない場合、一意の自動生成された名前がフィールドに割り当てられます。
x	x	True	double	フィールドの左の位置 (ピクセル単位)。
y	y	True	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	True	double	フィールドの幅 (ピクセル単位)。
高さ	height	True	double	フィールドの高さ (ピクセル単位)。

返品

Body

AddFieldResponse

塗りつぶしのイニシャル

操作 ID:

V4_Initials_Fill

ビジネス アプリケーションでは、このサービス API を使用して、指定されたユーザーがドキュメント内のイニシャル フィールドに順番に入力できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージ ID。
ドキュメント ID	documentId	True	integer	ドキュメントの ID。
field_name	field_name	True	string	ドキュメント内のフィールドの一意識別子。
イメージ	image	True	string	イニシャルの塗りつぶしに使用される Base64 イメージ。
メソッド	method			署名のユーザーによるハンド 署名メソッドの名前。 ハンド シグネチャ メソッドが指定されていない場合、既定値は DRAW になります。 指定できる値 DRAW、TEXT、UPLOAD、SIGNATURE_PAD
apply_to_all	apply_to_all	True	boolean	True の 場合は、すべてのイニシャルを入力します。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

添付ファイルのアップロード

操作 ID:

V4_Attachment_UploadAttachment

ビジネス アプリケーションでは、このサービス API を使用してドキュメントに添付ファイルをアップロードできます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	添付ファイルを追加する必要があるドキュメントの ID。
添付ファイル	file (binary Stream)		binary	これは、未加工のバイナリ形式のドキュメントです。
フィールド名	x-field-name		string	必要に応じてフィールド名。 これは省略可能で、フィールド名の添付ファイル フィールドは processed. さらに、フィールド名パラメーターの推奨値は Base64 エンコード形式です。
ファイル名	x-file-name	True	string	拡張子が付いたファイルの名前です。
ドキュメント パスワード	x-password		string	ドキュメントにアクセスするためにドキュメント所有者によって設定されたパスワード (存在する場合)。 パスワードが設定されていない場合、値は null になります。
One-Time パスワード	x-otp		string	ドキュメント所有者がドキュメントにアクセスするために設定した One-Time パスワード (OTP) (存在する場合)。 OTP が設定されていない場合、値は null になります。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

Body

AddAttachmentResponse

添付ファイルのダウンロード

操作 ID:

V4_Attachment_DownloadAttachment

ビジネス アプリケーションでは、このサービス API を使用してドキュメントの添付ファイルをダウンロードできます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	添付ファイルが追加されるドキュメントの ID。
添付ファイルの ID	attachment_id	True	integer	添付ファイルの ID。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

添付ファイルの削除

操作 ID:

V4_Attachment_DeleteAttachment

ビジネス アプリケーションでは、このサービス API を使用してドキュメントの添付ファイルを削除できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	添付ファイルが追加されるドキュメントの ID。
添付ファイルの ID	attachment_id	True	integer	添付ファイルの ID。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

object

添付ファイルを取得する

操作 ID:

V4_Attachment_GetAttachments

ビジネス アプリケーションでは、このサービス API を使用してドキュメントの添付ファイルを取得できます。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージのパッケージ ID。
ドキュメント ID	documentId	True	integer	添付ファイルが追加されるドキュメントの ID。
フォルダー ID	x-folder-id		string	共有スペース フォルダーが関係する場合に、フォルダーアイテムを取得するためのフォルダー ID を指定します。

返品

response

array of GetAttachmentResponse

自動配置フィールド

操作 ID:

V4_Fields_AutoPlace

ビジネス アプリケーションでは、この API を呼び出して、指定された検索条件に基づいて署名またはユーザー定義のフォーム フィールドをドキュメントに追加できます。 配置オプションは、左、右、上、下です。 ドキュメントが検索され、検索条件が満たされたすべてのインスタンスが処理されます。 これにより、1 回の呼び出しで複数のフィールドを追加できます。 たとえば、ドキュメントをアップロードし、"Sign here:" という単語のすべてのインスタンスの右側に署名フィールドを自動的に配置します。 これにより、時間が節約され、ワークフローから署名が失われないようにします。

API 呼び出しでは、すべての種類のフィールドがサポートされます。すなわち、電子、デジタル、対人、イニシャル、およびテキストフィールドなど。

さらに、API 呼び出しでは "order" 変数がサポートされます。つまり、署名フィールドのセットを 1 人のユーザーに自動的に割り当てることができます。そのため、呼び出しを繰り返して、ワークフロー内の複数のユーザーに署名フィールドを配置して割り当てることができます。

この方法で署名フィールドをドキュメントに追加するには、ワークフローに少なくとも 1 人のユーザーが存在している必要があります。注文番号は、ワークフローの受信者に対応します。 したがって、この数は、ワークフロー内のユーザーの合計数以下である必要があります。 次の例では、この新しい署名フィールドをワークフローの最初のユーザーに割り当てます。

この API 呼び出しは、同じドキュメントで複数回使用できます。その理由は、ドキュメント上の複数の署名者に対応するためです。受信者または署名者は、呼び出しで渡された "order" 変数によって識別されます。

詳細については、「 ワークフローへのユーザーの追加 」を参照してください。 テンプレートが適用されたドキュメントがある場合、または API を使用してドキュメントを適用している場合、ワークフローには既にユーザーが含まれています。

パラメーター

名前	キー	必須	型	説明
パッケージ識別子	packageId	True	integer	ドキュメントが追加されるパッケージの ID。
ドキュメント ID	documentId	True	integer	フィールドが要求されるドキュメントの ID。
search_text	search_text		string	ドキュメントで検索する必要があるWord。
順序	order	True	integer	フィールドが自動的に割り当てられるユーザーの順序。 SigningHub で受信者を注文するワークフロー。 このリストは、最初に指定された署名者の "1" で始まります。
配置	placement		string	テキストが見つかった場合、フィールドはドキュメントに配置されます。 フィールドの配置は、この属性で説明できます。 フィールドの配置に使用できる値は、LEFT、RIGHT、TOP、BOTTOM です。 値が指定されていない場合、既定値は LEFT になります。
field_type	field_type		string	ドキュメントに作成するフィールドの種類。 使用できる値は、"SIGNATURE"、"IN_PERSON_SIGNATURE"、"INITIALS"、"TEXT"、"NUMBER"、"NAME"、"EMAIL"、"COMPANY"、"JOBTITLE"、"RADIOBOX"、"CHECKBOX"、"DATE"、"ATTACHMENT" です。
level_of_assurance	level_of_assurance		array of string	更新される保証レベル。 使用できる値は、"ELECTRONIC_SIGNATURE"、"ELECTRONIC_SEAL"、"ADVANCED_ELECTRONIC_SEAL"、"QUALIFIED_ELECTRONIC_SEAL"、"ADVANCED_ELECTRONIC_SIGNATURE"、"HIGH_TRUST_ADVANCED"、"QUALIFIED_ELECTRONIC_SIGNATURE" です。
dimensions	dimensions			ドキュメントに作成するフィールドのディメンション。 X と Y の位置は自動的に計算されます。 API では、フィールドの幅と高さのみを構成できます。 ディメンションが指定されていない場合は、既定のディメンションに従います。 200 x 80 ピクセルです。
プレースホルダ	placeholder		string	必須の添付ファイルの場合はメモを入力してください
radio_group_name	radio_group_name		string	複数のラジオ ボックスをグループ化するためにラジオ ボックスの種類フィールドを追加する場合にのみ必要なグループ名。
format	format		string	フィールドのテキスト形式。 日付型フィールドにのみ使用されます。 使用可能な値は次のいずれかです: m/d m/d/yy m/d/yyyy mm/dd/yy mm/dd/yyyy mm/yy mm/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d、yyyy dd/mm/yy ddmmmyyyy
value	value		string	ユーザーがフィールドに表示する値。
max_length (最大長)	max_length	True	integer	フィールドで使用できる値の最大長。 1 ~ 9999 の間
validation_rule	validation_rule		string	フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。
入力規則	validation			Validations
フォント	font			フィールド テキストのフォント
multiline	multiline	True	boolean	これはテキストエリアフィールドタイプに属し、trueに設定すると、テキストエリアフィールドは複数行オプションで作成されます。

返品

response

array of AutoPlaceFieldsResponse

連絡先を取得する

操作 ID:

V4_Contacts_Get

ビジネス アプリケーションでは、このサービス API を使用して、現在のユーザーの個人連絡先とエンタープライズ連絡先の両方から連絡先を取得できます。

"x-search-text" ヘッダーの下に指定された条件に基づいて検索できます。さらに、ユーザーの特定の連絡先、またはユーザーが属している企業の連絡先を検索することもできます。

検索応答情報には、ユーザーの電子メール アドレスとそれぞれのユーザー名が含まれます。

パラメーター

名前	キー	必須	型	説明
各ページのレコード	recordPerPage	True	integer	ページで取得するレコードの合計数。
ページ番号	pageNo	True	integer	取得するページ番号。
並べ替え順	sort-by		string	上記で説明した値で結果を並べ替えます。
[昇順]	asc		boolean	結果セットを昇順または降順で並べ替えます。
テキストの検索	x-search-text		string	必要に応じてテキストを検索します。 これは省略可能であり、指定しないとリスト全体が返されます。 さらに、検索テキスト パラメーターの推奨値は Base64 でエンコードされた形式です。
エンタープライズ連絡先のみ	x-enterprise		string	"true" に設定すると、エンタープライズ連絡先リストのみが返されます。 "false" の場合は、ユーザーの連絡先リストのみが返されます。ヘッダーを設定しない場合は、エンタープライズとユーザーの連絡先リストの両方が返されます。
合計レコード数	x-total-records		string	指定された検索条件で見つかったレコードの合計数。

返品

response

array of ContactResponse

定義

ElectronicSealRecipient

名前	パス	型	説明
名前	name	string
level_of_assurance	level_of_assurance	string

ReminderResponse

名前	パス	型	説明
enabled	enabled	boolean	True の 場合、受信者に対してアラームが有効になっている
周波数	frequency	string	アラームの頻度。 使用可能な値は DAYS |時間。
remind_after	remind_after	integer	最初のアラームがワークフロー ユーザーに送信される日数。
繰り返す	repeat		アラームの詳細が繰り返されるかどうかにかかわらず、オブジェクトを繰り返します。

AddQrCodeResponse

名前	パス	型	説明
データ	data	string	QR コードで生成されたデータ
field_name	field_name	string	ドキュメントに作成されたフィールドの名前。
value	value	string	値は QrCode イメージの base64 になります

AddFieldResponse

名前	パス	型	説明
field_name	field_name	string	ドキュメントに作成されたフィールドの名前。
created_on	created_on	string	フィールド作成の日付と時刻。

SignatureFieldResponse

名前	パス	型	説明
field_name	field_name	string	ドキュメントに作成されたフィールドの名前。
created_on	created_on	string	フィールド作成の日付と時刻。

UpdateQrCodeResponse

名前	パス	型	説明
value	value	string	値は QrCode イメージの base64 になります

CertifyResponse

名前	パス	型	説明
enabled	enabled	boolean	True の 場合は、署名の認定の設定がドキュメントに対して有効になっています。
allowed_permissions	allowed_permissions	array of string	署名の認定設定を使用して、ドキュメントに対して設定されたアクセス許可レベルを認定します。
default_permission	default_permission	string

GroupMemberResponse

名前	パス	型	説明
user_email	user_email	string	グループ メンバーのメール アドレス
user_name	user_name	string	グループ メンバーのユーザー名

コラボレーターResponse

名前	パス	型	説明
user_email	user_email	string	ユーザーの電子メール
signing_order	signing_order	integer	署名順序
guest_user	guest_user	boolean	ゲスト ユーザー
email_language_code	email_language_code	string	電子メール言語コード
アクセス許可	permission		ドキュメント パッケージ内の受信者のアクセス許可
アラーム	reminder		受信者のアラーム設定。

WorkflowPermissionResponse

名前	パス	型	説明
印刷する	print	boolean	True の 場合は、この受信者の印刷が許可されます。
ダウンロード	download	boolean	ダウンロードが許可されている場合は True。
add_text	add_text	boolean	True の 場合は、ドキュメントにテキスト注釈を追加できます。
change_recipients	change_recipients	boolean	True の 場合、現在の注文の受信者は、ワークフローが共有された後、ワークフロー内の他の受信者を変更できます。
add_attachment	add_attachment	boolean	True の 場合、添付ファイルと PDF ドキュメントのマージが許可されます。
legal_notice	legal_notice		受信者の所有者によって設定された法的通知。
愛着	attachment		添付ファイル

EnterpriseTemplateResponse

名前	パス	型	説明
id	id	integer	テンプレートの ID
名前	name	string	テンプレートの名前。
公開	public	boolean	エンタープライズ テンプレートがパブリックとしてマークされている場合、応答は "true" になります。 それ以外の場合は "false" が返されます
read_only	read_only	boolean	テンプレートが読み取り専用で、ユーザーがこのテンプレートを適用した後にワークフローに変更を加えることができない場合は、"true" の応答。 それ以外の場合は "false" です。
description	description	string	テンプレートの説明
created_on	created_on	string	テンプレートが作成された日時
roles	roles	array of EnterpriseTemplateRole
書類	documents	array of TemplateDocumentResponse

EnterpriseTemplateRole

名前	パス	型	説明
名前	name	string	ユーザーに割り当てられているエンタープライズ ロールの名前。
id	id	integer	ユーザーに割り当てられているエンタープライズ ロールの ID。

TemplateDocumentResponse

名前	パス	型	説明
id	id	integer	テンプレート ドキュメントの ID
名前	name	string	テンプレート ドキュメントの名前。

Next_signer_email

名前	パス	型	説明
user_email	user_email	string	次の署名者の電子メール アドレス。
user_name	user_name	string	次の署名者の名前。

WorkflowRecipient

名前	パス	型	説明
順序	order	integer	ワークフロー内の受信者の順序。
user_email	user_email	string	ユーザーがグループでない場合の受信者のメール アドレス。
user_name	user_name	string	ユーザーがグループでない場合の受信者の名前。
mobile_number	mobile_number	string	携帯電話番号
delivery_method	delivery_method	string	受信者の配信方法 可能な値: EMAIL、SMS、またはEMAIL_AND_SMS
user_photo_url	user_photo_url	string	リソースにアクセスするための API エンドポイント。これは、メインの署名者にのみ提供されます。 たとえば、グループ/委任者/ゲートキーパーなどでは null になります。この URL では、署名者イメージが存在するかどうかは確認されません。 イメージが存在する場合は、定義された URL を押すことによって提供されます。それ以外の場合は空の文字列になります。
グループ名	group_name	string	受信者がグループの場合は、受信者のグループ名。
group_members	group_members	array of GroupMemberResponse	受信者がグループの場合は、グループ メンバーのメール アドレスの一覧。
delegatee	delegatee	string	受信者がグループでない場合は、電子メール アドレスを委任します。
delegatee_name	delegatee_name	string	受信者がグループでない場合は、委任されたユーザーの名前。
ロール	role	string	受信者が追加されたワークフロー ロール。 このロールはエンタープライズ ロールではありません。 指定できる値は、"SIGNER"、"REVIEWER"、"CARBON_COPY"、"EDITOR" です。
理由	reason	string	ドキュメントの辞退、承認、または送信時にユーザーが提供する理由。
process_status	process_status	string	受信者のドキュメント処理状態。 指定できる値は、"UN_PROCESSED"、"IN_PROGRESS"、"SIGNED"、"REVIEWED"、"DECLINED"、"EDITED"、または "INVALID" です。
processed_on	processed_on	string	ドキュメントが処理された日付と時刻。
processed_as	processed_as	string	ユーザーは、コラボレーター、DELEGATOR、GROUP_MEMBER、または OWNER としてフィールドを処理できます。
processed_by	processed_by	string	ドキュメントを処理したユーザーの電子メール アドレス。
プレースホルダ	placeholder	string	受信者がプレースホルダーの場合のプレースホルダー テキスト
signing_order	signing_order	integer	ワークフローが受信者によって署名される順序。 この署名順序は、ワークフローの種類が "CUSTOM" に設定されている場合に重要です。
user_national_id	user_national_id	string	ユーザーの国内 ID 番号。 これは、ワークフロー内のユーザーを識別するのに役立ちます
guest_user	guest_user	boolean	Gest user
email_language_code	email_language_code	string	電子メール言語コード
electronic_seal	electronic_seal	ElectronicSealRecipient
ゲートキーパー	gatekeepers		ゲートキーパー

EnterpriseAccessResponse

名前	パス	型	説明
認証	authentication		受信者のドキュメントに適用される認証方法の詳細を含む認証オブジェクト。
authentication_signing	authentication_signing		パッケージの認証署名
access_duration	access_duration		受信者のアクセス証券の詳細を含むアクセス期間オブジェクト。

GetPackageDetailsResponse

名前	パス	型	説明
名前	name	string	ドキュメント パッケージの名前。
所有者	owner	DocumentOwner
read_only	read_only	boolean	True の 場合は、適用されたテンプレートが読み取り専用です。 読み取り専用テンプレートが適用されている場合、ユーザーは変更を加えることができません。
document_status	document_status	string	現在ログインしているユーザーのドキュメントの状態。 使用できる値は、"DRAFT"、"INPROGRESS"、"PENDING"、"DECLINED"、または "COMPLETED" です。
書類	documents	array of DocumentDetails

DocumentOwner

名前	パス	型	説明
名前	name	string	ドキュメント パッケージ所有者の名前。
メール	email	string	ドキュメント パッケージ所有者の電子メール。

DocumentDetails

名前	パス	型	説明
id	id	integer	新しく作成されたドキュメントの ID。
名前	name	string	ドキュメントの名前。
uploaded_on	uploaded_on	string	ドキュメントがアップロードされた日時。
modified_on	modified_on	string	ドキュメントが最後に変更された日時。
サイズ	size	integer	ドキュメントのサイズ (バイト単位)。
型	type	string	ドキュメントの種類 (例: "PDF")。
ソース	source	string	ドキュメントがアップロードされた場所 ("マイ アプリ" など) を識別します。

TemplateResponse

名前	パス	型	説明
template_id	template_id	integer	テンプレートの ID がここに返されます
template_name	template_name	string	テンプレートの名前。
template_public	template_public	boolean	エンタープライズ テンプレートがパブリックとしてマークされている場合、応答は "true" になります。 それ以外の場合は "false" が返されます
read_only	read_only	boolean	テンプレートが読み取り専用で、ユーザーがこのテンプレートを適用した後にワークフローに変更を加えることができない場合は、"true" の応答。 それ以外の場合は "false" です。
created_on	created_on	string	テンプレートが作成された日時
description	description	string	テンプレートの説明
エンタープライズ	enterprise	boolean	ユーザーが企業に属している場合は True。
書類	documents	array of TemplateDocumentResponse
smart_form	smart_form		スマート フォーム

StartWorkflowResponse

名前	パス	型	説明
package_id	package_id	integer	共有したパッケージのパッケージ ID。 個々の共有の場合、1 つ以上のパッケージが作成され、受信者と共有されます。 API は、パッケージの配列と、新しく作成されたドキュメントの ID を返します。
書類	documents	array of integer	共有する前にパッケージの一部であったドキュメント ID の配列。

WorkflowDetailsResponse

名前	パス	型	説明
package_id	package_id	integer	ドキュメント パッケージのパッケージ ID。
package_name	package_name	string	ドキュメント パッケージの名前。
shared_package	shared_package	boolean	共有パッケージ
package_owner	package_owner	string	ドキュメント パッケージ所有者の電子メール アドレス。
owner_name	owner_name	string	ドキュメント パッケージ所有者の名前。
package_status	package_status	string	現在ログインしているユーザーのドキュメントの状態。 使用できる値は、"DRAFT"、"INPROGRESS"、"PENDING"、"DECLINED"、"APPROVED"、"UPDATED"、または "COMPLETED" です。
フォルダ	folder	string	ドキュメント パッケージを含むフォルダーの名前。
folder_id	folder_id	integer	ドキュメント パッケージを含むフォルダーの ID。
ゲートキーパー	gatekeeper	boolean
next_signer	next_signer	string	ドキュメントが共有状態にある場合の次の署名者の名前。
next_signer_email	next_signer_email	array of Next_signer_email	次の署名者のユーザー名と電子メール アドレスを含むオブジェクト。 グループ署名者の場合、すべてのグループ メンバーの電子メール アドレスの一覧が表示されます。
uploaded_on	uploaded_on	string	ドキュメントがアップロードされた日時。
modified_on	modified_on	string	ドキュメントが最後に変更された日時。
ワークフロー	workflow		ワークフローの詳細を含むワークフロー オブジェクト。
書類	documents	array of WorkflowDocumentsResponse	パッケージにアップロードされたドキュメントの一覧。
users	users	array of WorkflowUserResponse	ワークフローの受信者の一覧。

WorkflowDocumentsResponse

名前	パス	型	説明
document_id	document_id	integer	ドキュメントの ID。
document_name	document_name	string	ドキュメントの名前。
document_type	document_type	string	PDF に変換する前にドキュメントがアップロードされたときの元のドキュメント拡張機能。
document_order	document_order	integer	ドキュメント パッケージ内のドキュメントの順序。
document_source	document_source	string	ドキュメントのアップロード元のドキュメントのソース。
update_required	update_required	boolean	True の 場合、ドキュメントを更新する必要があります。
document_height	document_height	integer	PDF ドキュメントの高さ。
document_width	document_width	integer	PDF ドキュメントの幅。
document_pages	document_pages	integer	ドキュメント内のページの合計数。
created_on	created_on	string	ドキュメントがアップロードされた日付と時刻。
modified_on	modified_on	string	ドキュメントが最後に変更された日付と時刻。
form_fields	form_fields	boolean	True の 場合、ドキュメントにフォーム フィールドがあります。
テンプレート	template		テンプレートの詳細と共にドキュメントに適用されるテンプレート オブジェクト。
証明	certify	CertifyResponse
lock_form_fields	lock_form_fields	boolean	True の 場合、文書が文書の最後のデジタル署名でフォーム フィールドをロックするように設定します。
ロックされている	locked	boolean
has_signed_signature_fields	has_signed_signature_fields	boolean	PDF ドキュメントのメタ情報: pdf ドキュメントに署名付き署名フィールドがある場合は true
attachments	attachments	boolean	True の 場合、ドキュメントに添付ファイルがあります。
conformance_level	conformance_level	string	ドキュメントの準拠レベル
document_size	document_size	integer	ドキュメントのサイズ。
フォーマット	formatted	boolean	このプロパティは XML ドキュメントを対象とします。このプロパティは、XML ドキュメントの書式が設定されているかどうかに関するページです。

WorkflowUserResponse

名前	パス	型	説明
順序	order	integer	ワークフロー内の受信者の順序。
user_name	user_name	string	受信者がグループでない場合の受信者の名前。 受信者がプレースホルダーの場合は、プレースホルダーの名前が含まれます。
user_email	user_email	string	受信者がグループまたはプレースホルダーでない場合の受信者のメール アドレス。
mobile_number	mobile_number	string	携帯電話番号
delivery_method	delivery_method	string	受信者の配信方法 可能な値: EMAIL、SMS、またはEMAIL_AND_SMS
user_photo_url	user_photo_url	string	リソースにアクセスするための API エンドポイント。これは、メインの署名者にのみ提供されます。 たとえば、グループ/委任者/ゲートキーパーなどでは null になります。この URL では、署名者イメージが存在するかどうかは確認されません。 イメージが存在する場合は、定義された URL を押すことによって提供されます。それ以外の場合は空の文字列になります。
グループ名	group_name	string	受信者がグループの場合は、グループの名前。
group_members	group_members	array of string	ユーザーのすべてのメール アドレスと名前の一覧。
delegator	delegator	string	この受信者に委任するユーザーの電子メール アドレス。
ゲートキーパー	gatekeeper	string	この受信者のゲートキーパーであるユーザーのメール アドレス。
ゲートキーパー	gatekeepers		ゲートキーパー
ロール	role	string	受信者の役割 ("SIGNER"、"REVIEWER"、"EDITOR"、"CARBON_COPY"、"INPERSON_HOST" など)。
process_status	process_status	string	受信者のドキュメント処理状態。 指定できる値は、"UN_PROCESSED"、"IN_PROGRESS"、"SIGNED"、"REVIEWED"、"DECLINED"、"EDITED"、または "INVALID" です。
processed_on	processed_on	string	ドキュメントが処理された日付と時刻。
processed_as	processed_as	string	ユーザーは、コラボレーター、DELEGATOR、GROUP_MEMBER、または OWNER としてフィールドを処理できます。
processed_by	processed_by	string	ドキュメントを処理したユーザーの電子メール アドレス。
理由	reason	string	ドキュメントの辞退、承認、または送信時にユーザーが提供する理由。
プレースホルダ	placeholder	string	受信者がプレースホルダーの場合は、プレースホルダー テキスト。
アクセス許可	permission		ドキュメント パッケージの所有者によって設定された受信者のアクセス許可。
authentications	authentications		受信者に対して構成された認証とアクセス証券の詳細を含む認証オブジェクト。
アラーム	reminder		アラーム設定の詳細を含む Reminder オブジェクト。
signing_order	signing_order	integer	ワークフローが受信者によって署名される順序。 この署名順序は、ワークフローの種類が "CUSTOM" に設定されている場合に重要です。
user_national_id	user_national_id	string	ユーザーの国内 ID 番号。 これは、ワークフロー内のユーザーを識別するのに役立ちます
guest_user	guest_user	boolean	Gest user
email_language_code	email_language_code	string	電子メール言語コード
electronic_seal	electronic_seal		電子シール

DocumentDetailsResponse

名前	パス	型	説明
document_id	document_id	integer	新しく作成されたドキュメントの ID。
document_name	document_name	string	ドキュメントの名前。
document_order	document_order	integer
document_type	document_type	string	ドキュメントの種類 (例: "PDF")。
document_width	document_width	integer	PDF 形式のドキュメントの幅。
document_height	document_height	integer	PDF 形式のドキュメントの高さ。
document_source	document_source	string	ドキュメントがアップロードされた場所 ("マイ アプリ" など) を識別します。
document_pages	document_pages	integer	ドキュメントの合計ページ数。
form_fields	form_fields	boolean	True の 場合、ドキュメントにフォーム フィールドがあります。
lock_form_fields	lock_form_fields	boolean	True の 場合は、最後の署名を持つフォーム フィールドのロックが有効です。
uploaded_on	uploaded_on	string	ドキュメントがアップロードされた日時。
modified_on	modified_on	string	ドキュメントが最後に変更された日時。
証明	certify		ドキュメントの認定署名の設定。
テンプレート	template		テンプレートの詳細 (テンプレートがドキュメントに適用されている場合)。

AddAttachmentResponse

名前	パス	型	説明
attachment_id	attachment_id	integer	添付ファイル ID

GetAttachmentResponse

名前	パス	型	説明
attachment_id	attachment_id	integer	添付ファイル ID
attachment_name	attachment_name	string	添付ファイル名

AddPackageResponse

名前	パス	型	説明
package_id	package_id	integer	ドキュメントの共有、ダウンロード、および状態の取得に後で使用するパッケージ ID。
workflow_mode	workflow_mode	string	パッケージの追加中に設定されるワークフロー モード。
workflow_type	workflow_type	string	ワークフローの種類。 指定できる値は、"SERIAL"、"PARALLEL"、"INDIVIDUAL"、"CUSTOM" です。

GetPackagesResponse

名前	パス	型	説明
package_id	package_id	integer	ドキュメント パッケージのパッケージ ID。
package_name	package_name	string	ドキュメント パッケージの名前。
package_owner	package_owner	string	ドキュメント パッケージ所有者の電子メール アドレス。
owner_name	owner_name	string	ドキュメント パッケージ所有者の名前。
shared_package	shared_package	boolean	共有パッケージ
gatekeeper_package	gatekeeper_package	boolean	Gatekeeper パッケージ
package_status	package_status	string	現在ログインしているユーザーのドキュメントの状態。 使用できる値は、"DRAFT"、"INPROGRESS"、"PENDING"、"DECLINED"、または "COMPLETED" です。
拡張子	extension	string	ドキュメント パッケージ拡張機能
workflow_mode	workflow_mode	string	ワークフロー モード
フォルダ	folder	string	ドキュメント パッケージを含むフォルダーの名前。
folder_id	folder_id	integer	ドキュメント パッケージを含むフォルダーの ID。
未 読	unread	boolean	True の 場合は、受信者がまだドキュメントを読み取っていません。
next_signer	next_signer	string	ドキュメントが共有状態にある場合の次の署名者の名前。
next_signer_email	next_signer_email	array of Next_signer_email	次の署名者のユーザー名と電子メール アドレスを含むオブジェクト。 グループ署名者の場合、すべてのグループ メンバーの電子メール アドレスの一覧が表示されます。
uploaded_on	uploaded_on	string	ドキュメントがアップロードされた日時。
modified_on	modified_on	string	ドキュメントが最後に変更された日時。
access_duration	access_duration		受信者がドキュメントにアクセスするための開始日時と終了日時を指定します。 受信者は、この期間を超えてドキュメントにアクセスすることはできません。 指定した時間内にドキュメントが処理されない場合、ドキュメントは拒否されたと見なされます。 これは、ヘッダーで "x-recipient-details" が true として渡された場合に提供されます
減少	decline		手動で辞退した場合、または Core 経由で自動で拒否する場合は、辞退の詳細を文書化します。 これは、ヘッダーで "x-recipient-details" が true として渡された場合に提供されます
サイズ	size	integer	ドキュメントのサイズ (バイト単位)。

DocumentResponse

名前	パス	型	説明
package_name	package_name	string	ドキュメント パッケージ名

UploadDocument

名前	パス	型	説明
documentId	documentId	integer	このプロパティは下位互換性のために保持され、以降のバージョンでは削除されます。 代わりにdocument_idを使用してください。
documentid	documentid	integer	ドキュメントの共有、ダウンロード、および状態の取得に後で使用するドキュメント ID。 は後で削除document_id使用されます
document_id	document_id	integer	ドキュメントの共有、ダウンロード、および状態の取得に後で使用するドキュメント ID。
document_name	document_name	string	ドキュメントの名前。
document_order	document_order	integer	パッケージ内のドキュメントの順序
document_type	document_type	string	ドキュメントの種類 (例: "PDF")。
document_source	document_source	string	ドキュメントがアップロードされた場所 ("マイ アプリ" など) を識別します。
document_width	document_width	integer	PDF 形式のドキュメントの幅。
document_height	document_height	integer	PDF 形式のドキュメントの高さ。
document_pages	document_pages	integer	ドキュメントの合計ページ数。
uploaded_on	uploaded_on	date-time	ドキュメントがアップロードされた日時。
modified_on	modified_on	date-time	ドキュメントが最後に変更された日時。
lock_form_fields	lock_form_fields	boolean	True の 場合は、最後の署名を持つフォーム フィールドのロックが有効です。
証明	certify		ドキュメントの認定署名の設定。
document_size	document_size	integer	アップロードされたドキュメント サイズ (バイト単位)
メタデータ	metadata		アップロードされたドキュメント PDF メタ情報
package_name	package_name	string	ドキュメント パッケージ名

CertifyPolicyResponse

名前	パス	型	説明
証明	certify		ドキュメントの署名設定を認定します。
lock_form_fields	lock_form_fields	boolean	True の 場合は、フォームフィールドは、現在の文書の最後のデジタル署名の後に PDF でロックされます。

BulkSignResponse

名前	パス	型	説明
状態	status	string
取引ID	transaction_id	string

BulkSignStatusResponse

名前	パス	型	説明
状態	status	string
パッケージ	packages	array of BulkSignPackagesStatus

BulkSignPackagesStatus

名前	パス	型	説明
id	id	integer
名前	name	string
状態	status	string
アクション	action	string	必要なアクション キーがある場合
エラー	error	string
パーセンテージ	percentage	integer
書類	documents	array of BulkSignActionDocumentModel	現在のパッケージ内のドキュメント

BulkSignActionDocumentModel

名前	パス	型	説明
id	id	integer
フィールド	fields	array of BulkSignActionFieldModel

BulkSignActionFieldModel

名前	パス	型	説明
名前	name	string
ハッシュ	hash	string
hashing_algo	hashing_algo	string

SignDocumentResponse

名前	パス	型	説明
field_name	field_name	string	検証が要求されたフィールドの名前。
状態	status	string	署名フィールドの状態を返します。 値は SIGNED、PENDING です。 状態は、eIDAS が有効なリモート承認署名に役立ちます。 署名要求がモバイルに送信された場合、状態は保留中です。
取引ID	transaction_id	string	このパラメーターは RAS 署名時に使用されます
検査	verification		署名の検証
authentication_access_token	authentication_access_token	string	ユーザーが OIDC 経由で認証されるときに OIDC id_tokenが含まれます

AutoPlaceFieldsResponse

名前	パス	型	説明
field_name	field_name	string	API によって自動生成されたフィールドの名前。

ContactResponse

名前	パス	型	説明
id	id	integer	連絡先の ID。
user_name	user_name	string	連絡先のユーザー名。
user_email	user_email	string	連絡先のメール アドレス。
mobile_number	mobile_number	string	連絡先の携帯電話番号。
エンタープライズ	enterprise	boolean	連絡先がエンタープライズの場合は True。
user_national_id	user_national_id	string	連絡先の国民 ID 番号
created_on	created_on	string	連絡先が追加されたときの DateTime。

WorkSpaceMembers

名前	パス	型	説明
名前	name	string	作業スペース・メンバーの名前
メール	email	string	作業領域メンバーの電子メール アドレス

WorkSpaceResponse

名前	パス	型	説明
id	id	integer	共有領域の ID
名前	name	string	共有領域の名前
所有者	owner		共有スペースの所有者
members	members	array of WorkSpaceMembers	共有スペースのメンバー

UploadDocumentLibraryResponse

名前	パス	型	説明
document_id	document_id	integer	新しく作成されたドキュメントの ID。
document_name	document_name	string	ドキュメントの名前。
document_size	document_size	integer	アップロードされたドキュメント サイズ (バイト単位)
document_order	document_order	integer	ドキュメントの順序
document_type	document_type	string	ドキュメントの種類 (例: "PDF")。
document_source	document_source	string	ドキュメントがアップロードされた場所 ("マイ アプリ" など) を識別します。
document_width	document_width	integer	PDF 形式のドキュメントの幅。
document_height	document_height	integer	PDF 形式のドキュメントの高さ。
document_pages	document_pages	integer	ドキュメントの合計ページ数。
uploaded_on	uploaded_on	date-time	ドキュメントがアップロードされた日時。
modified_on	modified_on	date-time	ドキュメントが最後に変更された日時。
form_fields	form_fields	boolean	True の 場合、ドキュメントにフォーム フィールドがあります。
lock_form_fields	lock_form_fields	boolean	True の 場合は、最後の署名を持つフォーム フィールドのロックが有効です。
証明	certify		ドキュメントの認定署名の設定。
テンプレート	template		テンプレートの詳細 (テンプレートがドキュメントに適用されている場合)。
package_name	package_name	string	パッケージ名
メタデータ	metadata		アップロードされたドキュメント PDF メタ情報

WorkflowHistoryResponse

名前	パス	型	説明
package_id	package_id	integer	ワークフロー履歴が要求されるパッケージの ID。
package_name	package_name	string
package_owner	package_owner	string	パッケージ所有者の電子メール アドレス。
owner_name	owner_name	string	パッケージ所有者の名前。
package_status	package_status	string	現在ログインしているユーザーが含まれるパッケージ/ドキュメントの状態。 使用できる値は、"DRAFT"、"INPROGRESS"、"PENDING"、"DECLINED"、"APPROVED"、"UPDATED"、または "COMPLETED" です。
next_signer	next_signer	string	次の受信者の名前。
next_signer_email	next_signer_email	array of Next_signer_email	次の受信者の名前と電子メール アドレスを持つオブジェクト。
書類	documents	array of WorkflowDocumentsResponse
アクション	actions	array of DocumentLogsActions

DocumentLogsActions

名前	パス	型	説明
log_id	log_id	integer	ドキュメントに対して実行されたアクションの ID。
date_time	date_time	string	アクションが実行された日時。
action_type	action_type	string
user_email	user_email	string	アクションを実行したユーザーの電子メール。
user_name	user_name	string	アクションを実行したユーザーの名前。
enterprise_name	enterprise_name	string	ユーザーが属するエンタープライズの名前。 ユーザーが企業に属していない場合、この要素は存在しません。
情報	information	DocumentLogsActionsInformation

DocumentLogsActionsInformation

名前	パス	型	説明
型	type	string	アクションに関する追加情報の種類 (例: "SIGNING_METHOD" は、ユーザーがドキュメントへの署名に使用した署名方法を意味します。
value	value	string	アクションに関する追加情報の値 ("LOCAL" など) は、ユーザーがローカルに保持されている資格情報を使用してドキュメントに署名した場合を意味します。

UpdateCollaboratorResponse

名前	パス	型	説明
user_email	user_email	string	ユーザーの電子メール
signing_order	signing_order	integer	署名順序
guest_user	guest_user	boolean	ゲスト ユーザー
email_language_code	email_language_code	string	電子メール言語コード

CollaboratorGroupResponse

名前	パス	型	説明
アクセス許可	permission		ドキュメント パッケージ内の受信者のアクセス許可
アラーム	reminder		受信者のアラーム設定。
signing_order	signing_order	integer	署名順序

コラボレーターPlaceholderResponse

名前	パス	型	説明
アクセス許可	permission		ドキュメント パッケージ内の受信者のアクセス許可
アラーム	reminder		受信者のアラーム設定。
signing_order	signing_order	integer	署名順序

FieldsResponse

名前	パス	型	説明
シグネチャ	signature	array of DigitalSignatureFieldResponse	ドキュメント内のすべてのデジタル署名の一覧。
hand_signature	hand_signature	array of HandSignatureFieldResponse
electronic_signature	electronic_signature	array of ElectronicSignatureFieldResponse
イニシャル	initials	array of InitialFieldResponse
in_person_signature	in_person_signature	array of object
アイテム	in_person_signature	object
SMS 送信	text	array of TextFieldResponse
ラジオ	radio	array of RadioFieldResponse
チェックボックス	checkbox	array of CheckboxFieldResponse
ドロップダウン	dropdown	array of DropdownFieldResponse
Listbox	listbox	array of ListBoxFieldResponse
qrcode	qrcode	array of QrCodeResponse
愛着	attachment	array of AttachmentFieldResponse
コメント	comment	array of CommentFieldResponse
unique_identifier	unique_identifier	array of UniqueIdentifierFieldResponse

DigitalSignatureFieldResponse

名前	パス	型	説明
順序	order	integer	このフィールドが割り当てられている受信者の順序。 フィールドが誰にも割り当てられない場合、値は null になります。
display_order	display_order	integer	SigningHub ビューアーに従って順序を表示します。
field_name	field_name	string	フィールドの一意識別子。
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
埋め込み	embedded	boolean	True の フィールドが PDF ドキュメントの一部である場合。
型	type	string	フィールドが割り当てられているかどうかを指定すると、指定できる値は ASSIGNED、UN_ASSIGNED、SIGNED、LOGGED_IN_USER、HIDDEN、PLACEHOLDER になります。
process_status	process_status	string	フィールドが処理されているかどうか。 使用可能な値は、UN_PROCESSED、PROCESSED です。
processed_on	processed_on	string	ドキュメントが処理される日時。
processed_as	processed_as	string	フィールドをコラボレーター、DELEGATEE、GROUP_MEMBER、または OWNER として処理したユーザー。
created_on	created_on	string	フィールドが追加される日時
processed_by	processed_by	string	フィールドを処理したユーザーの電子メール アドレス。
dimensions	dimensions	FieldDimenssionResponse
検査	verification		署名フィールドの検証応答を返します。 検証がない場合は、null が返されます。
Nid	nid	string
表示	display	string	デジタル署名フィールドの表示値を返します。使用可能な値は "VISIBLE" と "INVISIBLE" です。
level_of_assurance	level_of_assurance	array of string
認証	authentication		Authentication

FieldDimenssionResponse

名前	パス	型	説明
フィールド	field	FieldResponse
ページ	page	PageResponse

FieldResponse

名前	パス	型	説明
x	x	double	フィールドの左の位置 (ピクセル単位)。
y	y	double	フィールドの最上位の位置 (ピクセル単位)。
width	width	double	フィールドの幅 (ピクセル単位)。
高さ	height	double	フィールドの高さ (ピクセル単位)。

PageResponse

名前	パス	型	説明
width	width	float	PDF にフィールドを配置するページの幅。
高さ	height	float	PDF にフィールドを配置するページの高さ。

HandSignatureFieldResponse

名前	パス	型	説明
順序	order	integer	このフィールドが割り当てられている受信者の順序。 フィールドが誰にも割り当てられない場合、値は null になります。
display_order	display_order	integer	SigningHub ビューアーに従って順序を表示します。
field_name	field_name	string	フィールドの一意識別子。
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
埋め込み	embedded	boolean	True の フィールドが PDF ドキュメントの一部である場合。
型	type	string	フィールドが割り当てられているかどうかを指定すると、指定できる値は ASSIGNED、UN_ASSIGNED、SIGNED、LOGGED_IN_USER、HIDDEN、PLACEHOLDER になります。
process_status	process_status	string	フィールドが処理されているかどうか。 使用可能な値は、UN_PROCESSED、PROCESSED です。
processed_on	processed_on	string	ドキュメントが処理される日時。
processed_as	processed_as	string	フィールドをコラボレーター、DELEGATEE、GROUP_MEMBER、または OWNER として処理したユーザー。
processed_by	processed_by	string	フィールドを処理したユーザーの電子メール アドレス。
dimensions	dimensions	FieldDimenssionResponse
Nid	nid	string

ElectronicSignatureFieldResponse

名前	パス	型	説明
順序	order	integer	フィールドを処理したユーザーの電子メール アドレス。
display_order	display_order	integer	SigningHub ビューアーに従って順序を表示します。
field_name	field_name	string	フィールドの一意識別子。
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
埋め込み	embedded	boolean	True の フィールドが PDF ドキュメントの一部である場合。
型	type	string	フィールドが割り当てられているかどうかを指定すると、指定できる値は ASSIGNED、UN_ASSIGNED、SIGNED、LOGGED_IN_USER、HIDDEN、PLACEHOLDER になります。
process_status	process_status	string	フィールドが処理されているかどうか。 使用可能な値は、UN_PROCESSED、PROCESSED です。
processed_on	processed_on	string	ドキュメントが処理される日時。
processed_as	processed_as	string	フィールドをコラボレーター、DELEGATEE、GROUP_MEMBER、または OWNER として処理したユーザー。
processed_by	processed_by	string	フィールドを処理したユーザーの電子メール アドレス。
dimensions	dimensions	FieldDimenssionResponse
signature_sub_type	signature_sub_type	string	署名のサブタイプには、WITNESS 署名を指定できます。 サービス プランでミラーリング監視署名が有効になっている場合、E-Signature フィールドは、サービス プラン内のすべてのユーザーが共有する共通の証明書で署名されます。 指定できる値は WITNESS または NONE です。
認証	authentication		Authentication
検査	verification		フィールドの検証応答を返します。 検証がない場合は、null が返されます。
Nid	nid	string
表示	display	string	電子署名フィールドの表示値を返します。使用可能な値は "VISIBLE" と "INVISIBLE" です。

InitialFieldResponse

名前	パス	型	説明
順序	order	integer	このフィールドが割り当てられている受信者の順序。 フィールドが誰にも割り当てられない場合、値は null になります。
display_order	display_order	integer	SigningHub ビューアーに従って順序を表示します。
field_name	field_name	string	フィールドの一意識別子。
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
process_status	process_status	string	フィールドが処理されているかどうか。 使用可能な値は、UN_PROCESSED、PROCESSED です。
processed_on	processed_on	string	ドキュメントが処理される日時。
processed_as	processed_as	string	フィールドをコラボレーター、DELEGATEE、GROUP_MEMBER、または OWNER として処理したユーザー。
processed_by	processed_by	string	フィールドを処理したユーザーの電子メール アドレス。
dimensions	dimensions	FieldDimenssionResponse
埋め込み	embedded	boolean	True の フィールドが PDF ドキュメントの一部である場合。

TextFieldResponse

名前	パス	型	説明
field_locale	field_locale	string	フィールドローカル。 使用可能な値は ar-AE |en-US. 省略可能で、既定値は en-US。 この値は型 "DATE" に重要です。
required	required	boolean	true の場合、フィールドが pdf に必要です。
順序	order	integer	このフィールドが割り当てられている受信者の順序。 フィールドが誰にも割り当てられない場合、値は null になります。
tab_order	tab_order	integer	PDF ドキュメントのタブ オーダー
display_order	display_order	integer	SigningHub ビューアーに従って順序を表示します。
field_name	field_name	string	フィールドの一意識別子。
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
埋め込み	embedded	boolean	True の フィールドが PDF ドキュメントの一部である場合。
型	type	string	テキスト フィールドの種類、使用可能な値は "TEXT"、"NAME"、"COMPANY"、"JOBTITLE"、"EMAIL"、"DATE" です。
value	value	string	フィールドの値。 型 = DATE または format_type = DATE の場合、値は ISO 8601 形式に従う必要があります。YYYY-MM-DD hh:mm:ss +00 の形式に従います。 値は日付フィールドのため、クライアント アプリケーションは YYYY-MM-DD を送信し、hh:mm:ss +00 を無視できます。 値が適切な形式でない場合は、エラーが返されます。
read_only	read_only	boolean	True の フィールドが PDF ドキュメントで読み取り専用としてマークされている場合。
validation_rule	validation_rule	string	フィールドの検証に使用できる 1 つ以上のルールは、"MANDATORY" または "OPTIONAL" です。
入力規則	validation		このオブジェクトは、必要な Value を渡すために使用されます。
visible	visible	boolean	True の 場合、フィールドが PDF ドキュメントで非表示にされていません。
multiline	multiline	boolean	True の 場合、フィールドが PDF ドキュメント内の複数行です。
フォント	font	FontResponse
max_length (最大長)	max_length	integer	フィールドに入力できる最大コンテンツ長。
format_type	format_type	string	フィールドがテキスト ボックスの場合は、さまざまな入力の種類に従うことができます。 使用できる値は、英数字、数値、テキスト、電子メール、時刻、日付です。
プレースホルダ	placeholder	string	テキスト ボックス フィールドのプレースホルダー テキスト。
format	format	string	フィールドのテキスト形式。 日付型フィールドにのみ使用されます。 使用可能な値は次のいずれかです: m/d m/d/yy m/d/yyyy mm/dd/yy mm/dd/yyyy mm/yy mm/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d、yyyy dd/mm/yy ddmmmyyyy
color	color	string	フォーム フィールド内のテキストの色。
ボーダー_カラー	border_color	string	フォーム フィールドの境界線の色。
ヒント	tooltip	string	フォーム フィールドのツールヒント。
field_rotation	field_rotation	integer	フィールドの回転
アライン	align	string	フォーム フィールドのテキストの配置。 指定できる値は、"RIGHT"、"LEFT"、"CENTER"、または "JUSTIFY" です。
dimensions	dimensions	FieldDimenssionResponse

RadioFieldResponse

名前	パス	型	説明
required	required	boolean	true の場合、フィールドが pdf に必要です。
順序	order	integer	このフィールドが割り当てられている受信者の順序。 フィールドが誰にも割り当てられない場合、値は null になります。
tab_order	tab_order	integer	PDF ドキュメントのタブ オーダー。
display_order	display_order	integer	SigningHub ビューアーに従って順序を表示します。
field_name	field_name	string	フィールドの一意識別子。
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
埋め込み	embedded	boolean	True の フィールドが PDF ドキュメントの一部である場合。
型	type	string
value	value	boolean	フィールドの値。
read_only	read_only	boolean	True の 場合は、フィールドが PDF ドキュメントで読み取り時にマークされます。
validation_rule	validation_rule	string	フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。
radio_group_name	radio_group_name	string	フィールドが属するグループ名。
確認済み	checked	boolean	フィールドが選択されている場合は True
visible	visible	boolean	TRUE フィールドが PDF ドキュメントで非表示でない場合です。
dimensions	dimensions	FieldDimenssionResponse
color	color	string	フォーム フィールド内のテキストの色。
ボーダー_カラー	border_color	string	フォーム フィールドの境界線の色。
ヒント	tooltip	string	フォーム フィールドのツールヒント。
field_rotation	field_rotation	integer	フィールドの回転

CheckboxFieldResponse

名前	パス	型	説明
required	required	boolean	true の場合、フィールドが pdf に必要です。
順序	order	integer	このフィールドが割り当てられている受信者の順序。 フィールドが誰にも割り当てられない場合、値は null になります。
tab_order	tab_order	integer	PDF ドキュメントのタブ オーダー
display_order	display_order	integer	SigningHub ビューアーに従って順序を表示します。
field_name	field_name	string	フィールドの一意識別子。
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
埋め込み	embedded	boolean	True の フィールドが PDF ドキュメントの一部である場合。
型	type	string
value	value	boolean	フィールドの値。
read_only	read_only	boolean	True の フィールドが PDF ドキュメントで読み取り専用としてマークされている場合。
確認済み	checked	boolean	True の場合、フィールドが選択されています。
visible	visible	boolean	TRUE フィールドが PDF ドキュメントで非表示でない場合です。
validation_rule	validation_rule	string	フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。
dimensions	dimensions	FieldDimenssionResponse
color	color	string	フォーム フィールド内のテキストの色。
ボーダー_カラー	border_color	string	フォーム フィールドの境界線の色。
ヒント	tooltip	string	フォーム フィールドのツールヒント。
field_rotation	field_rotation	integer	フィールドの回転

DropdownFieldResponse

名前	パス	型	説明
required	required	boolean	true の場合、フィールドが pdf に必要です。
順序	order	integer	このフィールドが割り当てられている受信者の順序。 フィールドが誰にも割り当てられない場合、値は null になります。
tab_order	tab_order	integer	PDF ドキュメントのタブ オーダー。
display_order	display_order	integer	SigningHub ビューアーに従って順序を表示します。
field_name	field_name	string	フィールドの一意識別子。
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
埋め込み	embedded	boolean	True の フィールドが PDF ドキュメントの一部である場合。
validation_rule	validation_rule	string	フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。
read_only	read_only	boolean	True の フィールドが PDF ドキュメントで読み取り専用としてマークされている場合。
value	value	string	フィールドの値。
選択肢	choices	array of string	ドロップダウンから値を選択するために使用できる選択肢。
visible	visible	boolean	True の 場合、フィールドが PDF ドキュメントで非表示にされていません。
dimensions	dimensions	FieldDimenssionResponse
フォント	font	FontResponse
color	color	string	フォーム フィールド内のテキストの色。
ボーダー_カラー	border_color	string	フォーム フィールドの境界線の色。
ヒント	tooltip	string	フォーム フィールドのツールヒント。
field_rotation	field_rotation	integer	フィールドの回転

ListBoxFieldResponse

名前	パス	型	説明
順序	order	integer	このフィールドが割り当てられている受信者の順序。 フィールドが誰にも割り当てられない場合、値は null になります。
tab_order	tab_order	integer	PDF ドキュメントのタブ オーダー。
display_order	display_order	integer	SigningHub ビューアーに従って順序を表示します。
field_name	field_name	string	フィールドの一意識別子。
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
埋め込み	embedded	boolean	True の フィールドが PDF ドキュメントの一部である場合。
validation_rule	validation_rule	string	フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。
read_only	read_only	boolean	True の フィールドが PDF ドキュメントで読み取り専用としてマークされている場合。
value	value	string	フィールドの値。
選択肢	choices	array of string	ドロップダウンから値を選択するために使用できる選択肢。
visible	visible	boolean	True の 場合、フィールドが PDF ドキュメントで非表示にされていません。
dimensions	dimensions	FieldDimenssionResponse
フォント	font	FontResponse
color	color	string	フォーム フィールド内のテキストの色。
ボーダー_カラー	border_color	string	フォーム フィールドの境界線の色。
ヒント	tooltip	string	フォーム フィールドのツールヒント。
field_rotation	field_rotation	integer	フィールドの回転

FontResponse

名前	パス	型	説明
名前	name	string	テキスト フィールドのフォント名。 ユーザー定義フィールドの場合、SigningHub では "COURIER"、"HELVETICA" のみがサポートされます。 PDF ファイル内の既存のフィールドの場合、フォント値は PDF で設定される任意の値にすることができます。
サイズ	size	integer	テキスト フィールドのフォント サイズ。
embedded_size	embedded_size	double	元の PDF ドキュメント内のフォントのサイズ。

QrCodeResponse

名前	パス	型	説明
field_name	field_name	string	フィールドの一意識別子。
型	type	string	QR などのフィールド型PDF_FIELD_TYPE
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
value	value	string	QrCode で生成された base64 は、ドラフト モードで提供されます
dimensions	dimensions	FieldDimenssionResponse
データ	data	string	QR コードでエンコードするプレーン テキスト データ。 既定では、関連するドキュメントにアクセスするために生成される URL です。 例: {base_url}/document/{document_unique_id}
options	options		オプションに関する設定
color	color		色に関する設定
ロゴ	logo		ロゴに関する設定

AttachmentFieldResponse

名前	パス	型	説明
順序	order	integer	このフィールドが割り当てられている受信者の順序。
display_order	display_order	integer	SigningHub ビューアーに従って順序を表示します。
field_name	field_name	string	フィールドの一意識別子。
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
process_status	process_status	string	フィールドが処理されているかどうか。 使用可能な値は、UN_PROCESSED、PROCESSED です。
processed_on	processed_on	string	ドキュメントが処理される日時。
processed_as	processed_as	string	フィールドをコラボレーター、DELEGATEE、GROUP_MEMBER、または OWNER として処理したユーザー。
processed_by	processed_by	string	フィールドを処理したユーザーの電子メール アドレス。
attachmentRefId	attachmentRefId	integer	Attachmet ref id
メモ	note	string	添付ファイルのメモ "必須" の添付ファイルルールの場合のみ
validation_rule	validation_rule		フィールドの有効な値を検証するための 1 つ以上の規則は、"MANDATORY" または "OPTIONAL" です。
dimensions	dimensions		寸法

CommentFieldResponse

名前	パス	型	説明
id	id	integer	コメント フィールド ID
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
unread_count	unread_count	integer	未読のコメント
非公開	private	boolean	Private
Recipients	recipients	array of CommentFieldRecipientResponse	受取人
dimensions	dimensions		ディメンション

UniqueIdentifierFieldResponse

名前	パス	型	説明
field_name	field_name	string	フィールドの一意識別子。
value	value	string	フィールドの値。
page_no	page_no	integer	フィールドが存在するドキュメントのページ番号。
フォント	font	FontResponse
dimensions	dimensions	FieldDimenssionResponse

CommentFieldRecipientResponse

名前	パス	型	説明
user_name	user_name	string	ユーザー名
user_email	user_email	string	ユーザーの電子メール

オブジェクト

これは型 'object' です。