IDCredential

public class IDCredential : Credential

Takes care of the ID verification process

  • Returned, when a document is found during a selfie.Done workflow.

    Declaration

    Swift

    public var lookupResult: Jumio.LookupResult? { get }

  • Represents all available countries in ISO 3166 ALPHA-3 with a corresponding list of Jumio.Document

    Declaration

    Swift

    @available(*, deprecated, message: "Use `Jumio.IDCredential.supportedCountries` together with `Jumio.IDCredential.physicalDocuments(for:﹚` and `Jumio.IDCredential.digitalDocuments(for:﹚` instead")
public var countries: [String : [Jumio.Document]] { get }

  • Represents all available countries in ISO 3166 ALPHA-3.

    Declaration

    Swift

    public var supportedCountries: [String] { get }

  • Suggests a country in ISO 3166 ALPHA-3 based on device region, if this country is supported

    Declaration

    Swift

    public var suggestedCountry: String? { get }

  • Validates a given country and document combination

    Declaration

    Swift

    public func isSupportedConfiguration(country: String, document: Jumio.Document) -> Bool

    Parameters

    country

    the ISO 3166 ALPHA-3 country code
    document

    Jumio.Document reference from Jumio.IDCredential.countries

    Return Value

    if country and document are supported

  • Sets a given country and document combination

    Declaration

    Swift

    public func setConfiguration(country: String, document: Jumio.Document)

    Parameters

    country

    the ISO 3166 ALPHA-3 country code
    document

    Jumio.Document reference from Jumio.IDCredential.countries

  • Get the Jumio.Document.Physical for the provided country code

    Declaration

    Swift

    public func physicalDocuments(for country: String) -> [Jumio.Document.Physical]

    Parameters

    country

    the ISO 3166 ALPHA-3 country code

    Return Value

    array of Jumio.Document.Physical

  • Get the Jumio.Document.Digital for the provided country code

    Declaration

    Swift

    public func digitalDocuments(for country: String) -> [Jumio.Document.Digital]

    Parameters

    country

    the ISO 3166 ALPHA-3 country code

    Return Value

    array of Jumio.Document.Digital

  • Give consent to process document found

    Declaration

    Swift

    public func userConsented(to legalStatement: Jumio.LookupResult.LegalStatement, decision: Bool)