SudoIdentityVerificationClient

public protocol SudoIdentityVerificationClient : AnyObject

Protocol encapsulating a set of functions for identity verification..

  • Retrieves the list of supported countries for identity verification.

    Declaration

    Swift

    func listSupportedCountries() async throws -> [String]

    Return Value

    List of support countries.

  • isFaceImageRequired() Asynchronous

    Retrieves the flag for whether face image is required with ID document.

    Declaration

    Swift

    func isFaceImageRequired() async throws -> Bool

    Return Value

    Boolean flag.

  • verifyIdentity(input:) Asynchronous

    Verifies an identity against the known public records and returns a result indicating whether or not the identity details provided were verified with enough confidence to grant the user access to Sudo platform functions such as provisioning a virtual card.

    Declaration

    Swift

    func verifyIdentity(input: VerifyIdentityInput) async throws -> VerifiedIdentity

    Parameters

    input

    Input variables for API.

    Return Value

    Verification result.

  • Attempts to verify an identity based on provided identity documents.

    Declaration

    Swift

    func verifyIdentityDocument(input: VerifyIdentityDocumentInput) async throws -> VerifiedIdentity

    Parameters

    input

    Input variables for API.

    Return Value

    Verification result.

  • Attempts to capture identity information from provided identity documents, then verify identity using that information.

    Declaration

    Swift

    func captureAndVerifyIdentityDocument(input: VerifyIdentityDocumentInput) async throws -> VerifiedIdentity

    Parameters

    input

    Input variables for API.

    Return Value

    Verification result.

  • Checks the identity verification status of the currently signed in user.

    Declaration

    Swift

    func checkIdentityVerification(option: QueryOption) async throws -> VerifiedIdentity

    Parameters

    option

    Option to determine whether to check the status in the backend or return the cached result.

    Return Value

    Verification result.

  • Resets any cached data.

    Throws

    SudoIdentityVerificationClientError

    Declaration

    Swift

    func reset() throws