SignRequestCreateSigner

public struct SignRequestCreateSigner : Encodable

Defines a signer for Create Sign Request",

  • Email address of the signer

    Declaration

    Swift

    public let email: String

  • Role of the signer

    Declaration

    Swift

    public let role: SignRequestSignerRole?

  • Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next inPerson signer.

    Declaration

    Swift

    public let isInPerson: Bool?

  • Order of the signer.

    Declaration

    Swift

    public let order: Int?

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

    Declaration

    Swift

    public let embedUrlExternalUserId: String?

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

    Declaration

    Swift

    public let redirectUrl: String?

  • The URL that a signer will be redirect to after declining to sign a document.

    Declaration

    Swift

    public let declinedRedirectUrl: String?

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

    Declaration

    Swift

    public let loginRequired: Bool?

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

    Declaration

    Swift

    public let verificationPhoneNumber: String?

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

    Declaration

    Swift

    public let password: String?

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

    Declaration

    Swift

    public let signerGroupId: String?

  • Initializer.

    Declaration

    Swift

    public init(
    email: String,
    role: SignRequestSignerRole? = nil,
    isInPerson: Bool? = nil,
    order: Int? = nil,
    embedUrlExternalUserId: String? = nil,
    redirectUrl: String? = nil,
    declinedRedirectUrl: String? = nil,
    loginRequired: Bool? = nil,
    verificationPhoneNumber: String? = nil,
    password: String? = nil,
    signerGroupId: String? = nil
)

    Parameters

    email

    Email address of the signer.
    role

    Role of the signer.
    isInPerson

    flag that is used in combination with an embed url for a sender. After the sender signs, they will be redirected to the next inPerson signer.
    order

    Order of the signer.
    embedUrlExternalUserId

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

    The URL that the signer will be redirected to after signing.
    declinedRedirectUrl

    The URL that a signer will be redirect to after declining to sign a document.
    loginRequired

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

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

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

    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 expected to have more than one signer.