Interface: SignRequest

SignRequest

Box Sign request A Box Sign request object.
Source:

Members

auto_expire_at :string

Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned. Example: 2021-04-26T08:12:13.982Z
Type:
  • string
Source:

id :string

Box Sign request ID. Example: 12345
Type:
  • string
Source:

parent_folder :schemas.FolderMini

The destination folder to place final, signed document and signing log. When this value was not passed in when the signature request was created, 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".
Type:
  • schemas.FolderMini
Source:

prepare_url :string

This URL is returned if `is_document_preparation_needed` is set to `true` in the request. The parameter is used to prepare the signature request using the UI. The signature request is not sent until the preparation phase is complete. Example: https://prepareurl.com
Type:
  • string
Source:

sign_files :object

List of files that will be signed, which are copies of the original source files. A new version of these files are created as signers sign and can be downloaded at any point in the signing process.
Type:
  • object
Source:

signature_color :string

Force a specific color for the signature (blue, black, or red). Example: blue
Type:
  • string
Source:

signers :Array

Array of signers for the signature request.
Type:
  • Array
Source:

signing_log :schemas.FileMini

Reference to a file that holds a log of all signer activity for the request.
Type:
  • schemas.FileMini
Source:

source_files :Array

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.
Type:
  • Array
Source:

status :'converting'|'created'|'sent'|'viewed'|'signed'|'cancelled'|'declined'|'error_converting'|'error_sending'|'expired'|'finalizing'|'error_finalizing'

Describes the status of the signature request. Example: converting
Type:
  • 'converting' | 'created' | 'sent' | 'viewed' | 'signed' | 'cancelled' | 'declined' | 'error_converting' | 'error_sending' | 'expired' | 'finalizing' | 'error_finalizing'
Source:

type :'sign-request'

object type Example: sign-request
Type:
  • 'sign-request'
Source: