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?

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

    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.