Box Sign request (Base)

A standard representation of a signature request object.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the base variant represent the default fields that are always returned when using the fields query parameter, additional to the fields specified in the parameter.

true

Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.

truetrue

Disables the usage of signatures generated by typing (text).

integer
20730

Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.

https://declined-redirect.com

The uri that a signer will be redirected to after declining to sign a document.

Hello! Please sign the document below

Message to include in sign request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including a, abbr, acronym, b, blockquote, code, em, i, ul, li, ol, and strong. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.

Sign Request from Acme

Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

123

This can be used to reference an ID in an external system that the sign request is related to.

Box

Used as an optional system name to appear in the signature log next to the signers who have been assigned the embed_url_external_id.

true

Indicates if the sender should receive a prepare_url in the response to complete document preparation using the UI.

true

Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them.

string
name

Name of the signature request.

The destination folder to place final, signed document and signing log. Only ID and type fields are required. The root folder, folder ID 0, cannot be used and can also not be null.

When this value is not passed in when the signature request, then we will use a default folder which is either the parent folder of the first source file in the payload if we have the permission to upload to that folder or a folder called "My Sign Requests".

object array

When a document contains sign-related tags in the content, you can prefill them using this prefill_tags by referencing the 'id' of the tag as the external_id field of the prefill tag.

true

Checkbox prefill value

2021-04-26

Date prefill value

1234

This references the ID of a specific tag contained in a file of the signature request.

text

Text prefill value

https://www.example.com

When specified, the signature request will be redirected to this url when a document is signed.

blue

Force a specific color for the signature (blue, black, or red)

Value is one of blue,black,red

object array

Array of signers for the signature request. 35 is the max number of signers permitted.

https://declined-example.com

The URL that a signer will be redirect to after declining to sign a document. Defining this URL overrides default or global declined redirect URL settings for a specific signer.

example@gmail.com

Email address of the signer. The email address of the signer is required when making signature requests, except when using templates that are configured to include emails.

1234

User ID for the signer in an external application responsible for authentication when accessing the embed URL.

true

Used in combination with an embed URL for a sender. After the sender signs, they are redirected to the next in_person signer.

true

If set to true, signer will need to login to a Box account before signing the request. If the signer does not have an existing account, they will have an option to create a free Box account.

20

Order of the signer

SecretPassword123

If set, the signer is required to enter the password before they are able to sign a document. This field is write only.

https://example.com

The URL that a signer will be redirected to after signing a document. Defining this URL overrides default or global redirect URL settings for a specific signer. If no declined redirect URL is specified, this URL will be used for decline actions as well.

signer"signer"

Defines the role of the signer in the signature request. A signer must sign the document and an approver must approve the document. A final_copy_reader only receives the final signed document and signing log.

Value is one of signer,approver,final_copy_reader

cd4ff89-8fc1-42cf-8b29-1890dedd26d7

If set, signers who have the same value will be assigned to the same input and to the same signer group. A signer group is not a Box Group. It is an entity that belongs to a Sign Request and can only be used/accessed within this Sign Request. A signer group is expected to have more than one signer. If the provided value is only used for one signer, this value will be ignored and request will be handled as it was intended for an individual signer. The value provided can be any string and only used to determine which signers belongs to same group. A successful response will provide a generated UUID value instead for signers in the same signer group.

false

If true, no emails about the sign request will be sent

6314578901

If set, this phone number is be used to verify the signer via two factor authentication before they are able to sign the document.

List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file.

123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb

When a signature request is created from a template this field will indicate the id of that template.

Response Example

{
  "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",
  "external_system_name": "Box",
  "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-26"
    }
  ],
  "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",
      "signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
      "suppress_notifications": false
    }
  ],
  "source_files": [
    {
      "id": "12345",
      "etag": "1",
      "type": "file"
    }
  ],
  "template_id": "123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb"
}