署名リクエストを作成

署名リクエストオブジェクトを作成するリクエスト

true

3、8、13、18日目にドキュメントに署名するよう署名者に促します。リマインダは未署名の署名者にのみ送信されます。

truetrue

(テキストの) 入力で生成された署名の使用を無効にします。

integer
20730

このリクエストが完了しなかった場合に自動的に期限切れになるまでの日数。

https://declined-redirect.com

署名者がドキュメントへの署名を拒否した後にリダイレクトされるURI。

Hello! Please sign the document below

署名リクエストメールに含めるメッセージ。このフィールドは、特定の文字のサニタイズによって消去されます。ただし、一部のHTMLタグは使用できます。また、このメッセージに含まれているリンクはメールではハイパーリンクに変換されます。このメッセージには、HTMLタグaabbracronymbblockquotecodeemiulliolstrongを含めることができます。HTMLに対するテキストの比率が大きすぎると、メールがスパムフィルタに入る可能性があることに注意してください。これらのタグにカスタムスタイルを適用することはできません。このフィールドを渡さない場合は、デフォルトのメッセージが使用されます。

Sign Request from Acme

署名リクエストメールの件名。これは、署名リクエストによって消去されます。このフィールドを渡さない場合は、デフォルトの件名が使用されます。

123

これは、署名リクエストが関連する外部システムのIDを参照する際に使用できます。

true

UIを使用してドキュメントの準備を完了するために送信者がレスポンスでprepare_urlを受け取る必要があるかどうかを示します。

true

ドキュメントを表示する前にテキストメッセージを確認するよう署名者に強制します。この設定を署名者に適用するには、署名者の電話番号を指定する必要があります。

string
name

署名リクエストの名前。

最終的な署名済みドキュメントと署名ログの保存先フォルダ。IDフィールドとtypeフィールドのみが必要です。ルートフォルダ (フォルダID 0) は使用できません。

object array

署名に関連するタグがドキュメントのコンテンツに含まれている場合、このprefill_tagsを使用してタグを事前入力できます。その際、タグの「id」を事前入力タグのexternal_idフィールドとして参照します。

true

チェックボックスの事前入力値

string / date-time
2021-04-26T08:12:13.982Z

日付の事前入力値

1234

これは、署名リクエストのファイルに含まれている特定のタグのIDを参照します。

text

テキストの事前入力値

https://www.example.com

指定した場合、ドキュメントに署名された時点で、署名リクエストがこのURLにリダイレクトされます。

blue

特定の署名の色 (青、黒、または赤) を強制します。

次の値のいずれか1つ: blue,black,red

object array

署名リクエストの署名者の配列。許可されている署名者の最大数は35です。

https://declined-example.com

署名者がドキュメントへの署名を拒否した後にリダイレクトされるURL。このURLを定義すると、特定の署名者で、デフォルトまたはグローバルのリダイレクトURL設定より優先されます。

example@gmail.com

署名者のメールアドレス

1234

埋め込みURLへのアクセス時に認証を担当する、外部アプリケーションの署名者のユーザーID。

true

送信者の埋め込みURLと組み合わせて使用されます。送信者が署名すると、その次のin_person署名者にリダイレクトされます。

true

trueに設定した場合、署名者はリクエストに署名する前にBoxアカウントにログインする必要があります。署名者に既存のアカウントがない場合は、無料のBoxアカウントを作成できます。

20

署名者の順序

SecretPassword123

設定した場合、署名者は、このパスワードを入力しないと、ドキュメントに署名できません。このフィールドは書き込み専用です。

https://example.com

署名者がドキュメントに署名した後にリダイレクトされるURL。このURLを定義すると、特定の署名者で、デフォルトまたはグローバルのリダイレクトURL設定より優先されます。拒否した場合のリダイレクトURLが指定されていない場合は、このURLが拒否の操作にも使用されます。

signer"signer"

署名リクエストに含まれる署名者のロールを定義します。signerはドキュメントに署名し、approverはドキュメントを承認する必要があります。最終的な署名済みドキュメントと署名ログを受け取るのは、final_copy_readerのみです。

次の値のいずれか1つ: signer,approver,final_copy_reader

6314578901

設定した場合は、2要素認証による署名者の認証にこの電話番号を使用しないと、署名者はドキュメントに署名できません。

110

署名用ドキュメントの作成元ファイルのリスト。現在は、10ファイルに制限されています。ファイルごとにIDフィールドと種類フィールドのみが必要です。source_filesが削除されると、この配列は空になります。

レスポンスの例

{
  "are_reminders_enabled": true,
  "are_text_signatures_enabled": true,
  "days_valid": 2,
  "declined_redirect_url": "https://declined-redirect.com",
  "email_message": "Hello! Please sign the document below",
  "email_subject": "Sign Request from Acme",
  "external_id": 123,
  "is_document_preparation_needed": true,
  "is_phone_verification_required_to_view": true,
  "name": "name",
  "parent_folder": {
    "id": 12345,
    "type": "folder",
    "etag": 1,
    "name": "Contracts",
    "sequence_id": 3
  },
  "prefill_tags": [
    {
      "document_tag_id": 1234,
      "text_value": "text",
      "checkbox_value": true,
      "date_value": "2021-04-26T08:12:13.982Z"
    }
  ],
  "redirect_url": "https://www.example.com",
  "signature_color": "blue",
  "signers": [
    {
      "email": "example@gmail.com",
      "role": "signer",
      "is_in_person": true,
      "order": 2,
      "embed_url_external_user_id": 1234,
      "redirect_url": "https://example.com",
      "declined_redirect_url": "https://declined-example.com",
      "login_required": true,
      "verification_phone_number": 6314578901,
      "password": "SecretPassword123"
    }
  ],
  "source_files": [
    {
      "id": 12345,
      "etag": 1,
      "type": "file",
      "sequence_id": 3,
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": 12345,
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      }
    }
  ]
}