Document

public struct Document : Codable, Sendable

Document model.

  • The type of document.

    Declaration

    Swift

    public let typeString: String

  • The type of document. Check typeString if nil.

    Declaration

    Swift

    public var type: DocumentType? { get }

  • The country of issuance.

    Declaration

    Swift

    public let countryOfIssuanceString: String?

  • The country of issuance.

    Declaration

    Swift

    public var countryOfIssuance: Country? { get }

  • The file in base64 format.

    Declaration

    Swift

    public let file: String?

  • Barcode data in base64.

    Declaration

    Swift

    public let barcodeData: String?

  • If the document failed to be verified, this field will contain the reasons why.

    Declaration

    Swift

    public let failReasons: [String]?

  • Data extracted from this document via OCR.

    Declaration

    Swift

    public let extractedData: DocumentExtractedData?

  • UIImage of the card.

    Note

    This will be nil when you list the cards for an account.

    Declaration

    Swift

    public var image: UIImage? { get }

  • Auxiliary constructor.

    Declaration

    Swift

    public init(
    typeString: String,
    file: String,
    barcodeData: String? = nil,
    countryOfIssuanceString: String? = nil
)

    Parameters

    typeString

    The type of document.
    file

    The file in base64 format.
    barcodeData

    Barcode data in base64.
    countryOfIssuanceString

    The country of issuance.