{
"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",
"type": "file",
"etag": "1"
}
],
"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": [
{
"page_index": 4,
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26",
"type": "text",
"content_type": "signature",
"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",
"type": "file",
"etag": "1",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
},
"status": "converting",
"sign_files": {
"files": [
{
"id": "12345",
"type": "file",
"etag": "1",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
}
],
"is_ready_for_download": true
},
"auto_expire_at": "2021-04-26T08:12:13.982Z",
"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
}
]
}Resources
Box Sign requests
A standard representation of a signature request, as returned from any Box Sign API endpoints by default.
The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
Example:
1000
The marker for the start of the next page of results.
Example:
"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
A list of Box Sign requests.
Show child attributes
Show child attributes
Last modified on January 23, 2026
Was this page helpful?
⌘I
