SignRequest

public class SignRequest : BoxModel

A standard representation of a sign request, as returned from any Box Sign API endpoints by default.

BoxModel

  • Box item type

    Declaration

    Swift

    public var type: String

  • Declaration

    Swift

    public private(set) var rawData: [String : Any] { get }

Properties

  • Signers for the sign request.

    Declaration

    Swift

    public let signers: [SignRequestSigner]
  • id

    Sign request ID

    Declaration

    Swift

    public let id: String

  • This URL is returned if isDocumentPreparationNeeded is set to true in the request. It is used to prepare the sign request via UI. The sign request is not sent until preparation is complete.

    Declaration

    Swift

    public let prepareUrl: String?

  • Reference to a file that holds a log of all signer activity for the request.

    Declaration

    Swift

    public let signingLog: File?

  • Status of the sign request.

    Declaration

    Swift

    public let status: SignRequestStatus?

  • 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.

    Declaration

    Swift

    public let signFiles: SignRequestSignFiles?

  • Uses daysValid to calculate the date and time, the sign request will expire if unsigned.

    Declaration

    Swift

    public let autoExpireAt: Date?

  • Indicates if the sender should receive a prepareUrl in the response to complete document preparation via UI.

    Declaration

    Swift

    public let isDocumentPreparationNeeded: Bool?

  • Disables the usage of signatures generated by typing (text). Default is true.

    Declaration

    Swift

    public let areTextSignaturesEnabled: Bool?

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

    Declaration

    Swift

    public let emailSubject: String?

  • 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.

    Declaration

    Swift

    public let emailMessage: String?

  • Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.

    Declaration

    Swift

    public let areRemindersEnabled: Bool?

  • List of files to create a signing document from.

    Declaration

    Swift

    public let sourceFiles: [File]

  • The destination folder to place final, signed document and signing log.

    Declaration

    Swift

    public let parentFolder: Folder

  • List of prefill tags.

    Declaration

    Swift

    public let prefillTags: [SignRequestPrefillTag]?

  • Number of days after which this request will automatically expire if not completed.

    Declaration

    Swift

    public let daysValid: Int?

  • A reference ID in an external system that the sign request is related to.

    Declaration

    Swift

    public let externalId: String?

  • The URL that a signer will be redirected to after signing a document.

    Declaration

    Swift

    public let redirectUrl: String?

  • The URL that a signer will be redirected to after declined signing a document.

    Declaration

    Swift

    public let declinedRedirectUrl: String?

  • Name of the sign request.

    Declaration

    Swift

    public let name: String?

  • 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.

    Declaration

    Swift

    public let isPhoneVerificationRequiredToView: Bool?

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

    Declaration

    Swift

    public let templateId: String?

  • Specific color for the signature (blue, black, or red).

    Declaration

    Swift

    public let signatureColor: SignRequestSignatureColor?

  • Initializer.

    Throws

    Decoding error.

    Declaration

    Swift

    public required init(json: [String : Any]) throws

    Parameters

    json

    JSON dictionary.