Box Sign

任意のBox Sign APIエンドポイントからデフォルトで返される、署名リクエストの標準レプリゼンテーション。

string
12345

署名リクエストID

string
sign-request

次の値に固定: sign-request

true

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

truetrue

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

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

days_validを使用すると、未署名の場合に署名リクエストの有効期限となる日時 (GMT) が計算されます。

integer
21-730

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

Hello! Please sign the document below

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

Sign Request from Acme

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

123

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

true

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

integer / int64
1000

これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。

integer / int64
3000

次の検索結果ページの開始場所のマーカー。

最終的な署名済みドキュメントと署名ログの保存先フォルダ。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://prepareurl.com

このURLは、リクエストでis_document_preparation_neededtrueに設定されている場合に返されます。これは、UIで署名リクエストを準備する際に使用されます。署名リクエストは、準備が完了するまで送信されません。

integer / int64
1000

前の検索結果ページの開始場所のマーカー。

object

署名されるファイル (元のソースファイルのコピー) のリスト。署名者が署名すると、これらのファイルの新しいバージョンが作成され、署名プロセスのどの時点でもダウンロードできます。

true

sign_filesのドキュメントが処理中で、PDFが古くなっている可能性があるかどうかを示します。任意のドキュメントを変更するには、すべてのsign_filesで処理が必要になります。処理が終了するまで (およびこの値がtrueになるまで) 待ってからPDFをダウンロードすることをお勧めします。

object array

署名リクエストの署名者の配列

example@gmail.com

署名者のメールアドレス

https://example.com

署名のために署名者に案内するURL

1234

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

true

署名者がドキュメントを表示する場合はtrueに設定します

object array
text

入力の種類

次の値のいずれか1つ: signature,date,text,checkbox

true

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

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

日付の事前入力値

1234

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

4

入力が配置されるページのインデックス

text

テキストの事前入力値

true

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

2

署名者の順序

signer"signer"

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

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

署名者による最終的な決定

signed

署名者による決定の種類

次の値のいずれか1つ: signed,declined

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

決定が行われた日時

リクエストに対する署名者のアクティビティがすべて記録されているファイルへの参照

署名するドキュメントの作成元ファイルのリスト。現在は、1ファイルに制限されています。ファイルごとにIDフィールドと種類フィールドのみが必要です。

string
converting

署名リクエストのステータスを説明します

次の値のいずれか1つ: converting,created,sent,viewed,signed,cancelled,declined,error_converting,error_sending,expired

レスポンスの例

{
  "id": 12345,
  "type": "sign-request",
  "are_reminders_enabled": true,
  "are_text_signatures_enabled": true,
  "auto_expire_at": "2021-04-26T08:12:13.982Z",
  "days_valid": 2,
  "email_message": "Hello! Please sign the document below",
  "email_subject": "Sign Request from Acme",
  "external_id": 123,
  "is_document_preparation_needed": true,
  "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"
    }
  ],
  "prepare_url": "https://prepareurl.com",
  "sign_files": {
    "files": [
      {
        "id": 12345,
        "etag": 1,
        "type": "file",
        "sequence_id": 3,
        "name": "Contract.pdf",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
        "file_version": {
          "id": 12345,
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        }
      }
    ],
    "is_ready_for_download": true
  },
  "signers": [
    {
      "email": "example@gmail.com",
      "role": "signer",
      "is_in_person": true,
      "order": 2,
      "embed_url_external_user_id": 1234,
      "has_viewed_document": true,
      "signer_decision": {
        "type": "signed",
        "finalized_at": "2021-04-26T08:12:13.982Z"
      },
      "inputs": [
        {
          "document_tag_id": 1234,
          "text_value": "text",
          "checkbox_value": true,
          "date_value": "2021-04-26T08:12:13.982Z",
          "type": "text",
          "page_index": 4
        }
      ],
      "embed_url": "https://example.com"
    }
  ],
  "signing_log": {
    "id": 12345,
    "type": "file",
    "etag": 1,
    "file_version": {
      "id": 12345,
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    },
    "name": "Contract.pdf",
    "sequence_id": 3,
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
  },
  "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"
      }
    }
  ],
  "status": "converting"
}