SignRequestCreateParameters

public struct SignRequestCreateParameters : Encodable

Defines a request to creatre a sign request object.

  • 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 prefill tags. When a document contains sign related tags in the content, you can prefill them using this prefillTags by referencing the id of the tag as the externalId field of the prefill tag.

    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?
  • This can be used to reference an ID in an external system that the sign request is related to.

    Declaration

    Swift

    public let externalId: String?
  • Initializer.

    Declaration

    Swift

    public init(
        isDocumentPreparationNeeded: Bool? = nil,
        areTextSignaturesEnabled: Bool? = nil,
        emailSubject: String? = nil,
        emailMessage: String? = nil,
        areRemindersEnabled: Bool? = nil,
        prefillTags: [SignRequestPrefillTag]? = nil,
        daysValid: Int? = nil,
        externalId: String? = nil
    )

    Parameters

    isDocumentPreparationNeeded

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

    areTextSignaturesEnabled

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

    emailSubject

    Subject of sign request email.

    emailMessage

    Message to include in sign request email.

    areRemindersEnabled

    Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18.

    prefillTags

    List of prefill tags.

    daysValid

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

    externalId

    ID that serve as reference in an external system that the sign request is related to.