Box Signリクエスト
Box Signリクエストオブジェクト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
is_document_preparation_needed | boolean | いいえ | UIを使用してドキュメントの準備を完了するために送信者がレスポンスでprepare_urlを受け取る必要があるかどうかを示します。 |
redirect_url | string | いいえ | 指定した場合、ドキュメントに署名された時点で、署名リクエストがこのURLにリダイレクトされます。 null を指定できます。 |
declined_redirect_url | string | いいえ | 署名者がドキュメントへの署名を拒否した後にリダイレクトされるURI。 null を指定できます。 |
are_text_signatures_enabled | boolean | いいえ | (テキストの) 入力で生成された署名の使用を無効にします。 |
email_subject | string | いいえ | 署名リクエストメールの件名。これは、署名リクエストによって消去されます。このフィールドを渡さない場合は、デフォルトの件名が使用されます。 null を指定できます。 |
email_message | string | いいえ | 署名リクエストメールに含めるメッセージ。このフィールドは、特定の文字のサニタイズによって消去されます。ただし、一部のHTMLタグは使用できます。また、このメッセージに含まれているリンクはメールではハイパーリンクに変換されます。このメッセージには、HTMLタグa、abbr、acronym、b、blockquote、code、em、i、ul、li、ol、strongを含めることができます。HTMLに対するテキストの比率が大きすぎると、メールがスパムフィルタに入る可能性があることに注意してください。これらのタグにカスタムスタイルを適用することはできません。このフィールドを渡さない場合は、デフォルトのメッセージが使用されます。 null を指定できます。 |
are_reminders_enabled | boolean | いいえ | 3、8、13、18日目にドキュメントに署名するよう署名者に促します。リマインダは未署名の署名者にのみ送信されます。 |
name | string | いいえ | 署名リクエストの名前。 |
prefill_tags | array of 署名リクエスト事前入力タグ | いいえ | 署名に関連するタグがドキュメントのコンテンツに含まれている場合、このprefill_tagsを使用してタグを事前入力できます。その際、タグの「id」を事前入力タグのexternal_idフィールドとして参照します。 |
days_valid | integer | いいえ | 作成した署名リクエストが完了しなかった場合に自動的に期限切れになるまでの日数を設定します。デフォルトでは、署名リクエストに有効期限を適用しないため、署名リクエストは期限切れになりません。 null を指定できます。 |
external_id | string | いいえ | これは、署名リクエストが関連する外部システムのIDを参照する際に使用できます。 null を指定できます。 |
template_id | string | いいえ | 署名リクエストがテンプレートから作成された場合、このフィールドはそのテンプレートのIDを示します。 null を指定できます。 |
external_system_name | string | いいえ | 署名ログで、embed_url_external_idが割り当てられている署名者の横に表示するシステム名 (省略可) として使用されます。 null を指定できます。 |
request_flow | string | いいえ | 署名リクエストのフロータイプ。値にはstandardまたはcfr11を指定できます。作成時に指定されていない場合、管理者設定に基づいてデフォルトが選択されます。 null を指定できます。 |
type | enum<string> | いいえ | 値は常にsign-requestになります。 使用可能なオプション: sign-request. |
source_files | array of ファイル (Base) | いいえ | 署名するドキュメントの作成元ファイルのリスト。現在は、10ファイルに制限されています。ファイルごとにIDフィールドとtypeフィールドのみが必要です。 |
signers | array of Box Signリクエストのレスポンスの署名者フィールド | いいえ | 署名リクエストの署名者の配列。 |
signature_color | string | いいえ | 署名に特定の色 (青、黒、または赤) を強制します。 null を指定できます。 |
id | string | いいえ | Box SignリクエストID。 |
prepare_url | string | いいえ | このURLは、リクエストでis_document_preparation_neededがtrueに設定されている場合に返されます。このパラメータは、UIを使用して署名リクエストを準備する際に使用されます。署名リクエストは、準備段階が完了するまで送信されません。 null を指定できます。 |
signing_log | ファイル (Mini) | いいえ | リクエストに対する署名者のアクティビティがすべて記録されているファイルへの参照。 |
status | enum<string> | いいえ | 署名リクエストのステータスを説明します。 使用可能なオプション: converting, created, sent, viewed, signed, cancelled, declined, error, error_converting, error_sending, expired, finalizing, error_finalizing. |
sign_files | object | いいえ | 署名されるファイル (元のソースファイルのコピー) のリスト。署名者が署名すると、これらのファイルの新しいバージョンが作成され、署名プロセスのどの時点でもダウンロードできます。 |
auto_expire_at | string | いいえ | days_validを使用すると、未署名の場合に署名リクエストの有効期限となる日時 (GMT) が計算されます。 null を指定できます。 |
parent_folder | フォルダ (Mini) | いいえ | 最終的な署名済みドキュメントと署名ログの保存先フォルダ。 署名リクエストの作成時にこの値が渡されなかった場合は、デフォルトのフォルダを使用することになります。デフォルトのフォルダは、ペイロードの最初のソースファイルの親フォルダ (そのフォルダへのアップロード権限がある場合) または「My Sign Requests」という名前のフォルダになります。 |
collaborator_level | string | いいえ | 署名リクエストに対するユーザーのコラボレータレベル。値には「owner」、「editor」、「viewer」を指定できます。 null を指定できます。 |
short_id | string | いいえ | 署名リクエストの短い識別子。 |
created_at | string | いいえ | 署名リクエストが作成された日時をマークするタイムスタンプ。 |
finished_at | string | いいえ | すべての署名操作が完了した日時を示すタイムスタンプ。 null を指定できます。 |
error_code | string | いいえ | 署名リクエストがエラー状態の場合、具体的な理由を特定します。エラーコードが適用されない場合はnullです。 読み取り専用。 null を指定できます。 |
sender_email | string | いいえ | 署名リクエストの送信者のメールアドレス。 null を指定できます。 |
sender_id | integer | いいえ | 署名リクエストの送信者のユーザーID。 null を指定できます。 |
例
{
"is_document_preparation_needed": true,
"redirect_url": "https://www.example.com",
"declined_redirect_url": "https://declined-redirect.com",
"are_text_signatures_enabled": true,
"email_subject": "Sign Request from Acme",
"email_message": "Hello! Please sign the document below",
"are_reminders_enabled": true,
"name": "name",
"prefill_tags": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26"
}
],
"days_valid": 2,
"external_id": "123",
"template_id": "123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb",
"external_system_name": "Box",
"request_flow": "standard",
"type": "sign-request",
"source_files": [
{
"id": "12345",
"etag": "1",
"type": "file"
}
],
"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",
"signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
"suppress_notifications": false,
"language": "en",
"has_viewed_document": true,
"signer_decision": {
"type": "signed",
"finalized_at": "2021-04-26T08:12:13.982Z",
"additional_info": "Requesting changes before signing."
},
"inputs": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26",
"type": "text",
"content_type": "signature",
"page_index": 4,
"read_only": true,
"validation": {
"validation_type": "email"
},
"reason": "I read and approve this document",
"is_validated": true
}
],
"embed_url": "https://example.com",
"iframeable_embed_url": "https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4",
"attachments": [
{
"id": "12345",
"name": "proof_of_identity.pdf"
}
]
}
],
"signature_color": "blue",
"id": "12345",
"prepare_url": "https://prepareurl.com",
"signing_log": {
"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",
"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
},
"auto_expire_at": "2021-04-26T08:12:13.982Z",
"parent_folder": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"collaborator_level": "owner",
"short_id": "SR-12345",
"created_at": "2025-02-01T12:00:00Z",
"finished_at": "2025-02-02T12:00:00Z",
"error_code": "cfr11_validation_failed",
"sender_email": "sender@box.com",
"sender_id": 12345
}
Box Signリクエスト
任意のBox Sign APIエンドポイントからデフォルトで返される署名リクエストのStandard版の表示。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
entries | array of Box Signリクエスト | いいえ | Box Signリクエストのリスト。 |
例
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"entries": [
{
"is_document_preparation_needed": true,
"redirect_url": "https://www.example.com",
"declined_redirect_url": "https://declined-redirect.com",
"are_text_signatures_enabled": true,
"email_subject": "Sign Request from Acme",
"email_message": "Hello! Please sign the document below",
"are_reminders_enabled": true,
"name": "name",
"prefill_tags": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26"
}
],
"days_valid": 2,
"external_id": "123",
"template_id": "123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb",
"external_system_name": "Box",
"request_flow": "standard",
"type": "sign-request",
"source_files": [
{
"id": "12345",
"etag": "1",
"type": "file"
}
],
"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",
"signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
"suppress_notifications": false,
"language": "en",
"has_viewed_document": true,
"signer_decision": {
"type": "signed",
"finalized_at": "2021-04-26T08:12:13.982Z",
"additional_info": "Requesting changes before signing."
},
"inputs": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26",
"type": "text",
"content_type": "signature",
"page_index": 4,
"read_only": true,
"validation": {
"validation_type": "email"
},
"reason": "I read and approve this document",
"is_validated": true
}
],
"embed_url": "https://example.com",
"iframeable_embed_url": "https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4",
"attachments": [
{
"id": "12345",
"name": "proof_of_identity.pdf"
}
]
}
],
"signature_color": "blue",
"id": "12345",
"prepare_url": "https://prepareurl.com",
"signing_log": {
"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",
"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
},
"auto_expire_at": "2021-04-26T08:12:13.982Z",
"parent_folder": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"collaborator_level": "owner",
"short_id": "SR-12345",
"created_at": "2025-02-01T12:00:00Z",
"finished_at": "2025-02-02T12:00:00Z",
"error_code": "cfr11_validation_failed",
"sender_email": "sender@box.com",
"sender_id": 12345
}
]
}