SudoIdentityVerificationClient Protocol Reference
SudoIdentityVerificationClient
public protocol SudoIdentityVerificationClient : AnyObjectProtocol encapsulating a set of functions for identity verification..
-
listSupportedCountries()AsynchronousRetrieves the list of supported countries for identity verification.
Declaration
Swift
func listSupportedCountries() async throws -> [String]Return Value
List of support countries.
-
isFaceImageRequiredWithDocumentCapture()AsynchronousRetrieves the flag for whether face image is required with ID document capture.
Declaration
Swift
func isFaceImageRequiredWithDocumentCapture() async throws -> BoolReturn Value
Boolean flag.
-
isFaceImageRequiredWithDocumentVerification()AsynchronousRetrieves the flag for whether face image is required with ID document verification.
Declaration
Swift
func isFaceImageRequiredWithDocumentVerification() async throws -> BoolReturn Value
Boolean flag.
-
isDocumentCaptureInitiationEnabled()AsynchronousRetrieves the flag for whether document capture can be initiated using initiateIdentityDocumentCapture().
Declaration
Swift
func isDocumentCaptureInitiationEnabled() async throws -> BoolReturn Value
Boolean flag.
-
isConsentRequiredForVerification()AsynchronousRetrieves the flag for whether consent is required in order to perform identity data processing.
Declaration
Swift
func isConsentRequiredForVerification() async throws -> BoolReturn 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 -> VerifiedIdentityParameters
inputInput variables for API.
Return Value
Verification result.
-
verifyIdentityDocument(input:Asynchronous) Attempts to verify an identity based on provided identity documents.
Declaration
Swift
func verifyIdentityDocument(input: VerifyIdentityDocumentInput) async throws -> VerifiedIdentityParameters
inputInput variables for API.
Return Value
Verification result.
-
captureAndVerifyIdentityDocument(input:Asynchronous) Attempts to capture identity information from provided identity documents, then verify identity using that information.
Declaration
Swift
func captureAndVerifyIdentityDocument(input: VerifyIdentityDocumentInput) async throws -> VerifiedIdentityParameters
inputInput variables for API.
Return Value
Verification result.
-
checkIdentityVerification()AsynchronousChecks the identity verification status of the currently signed in user.
Declaration
Swift
func checkIdentityVerification() async throws -> VerifiedIdentityReturn Value
Verification result.
-
initiateIdentityDocumentCapture()AsynchronousAttempts to initiate ID document capture using underlying provider’s web based method.
Declaration
Swift
func initiateIdentityDocumentCapture() async throws -> IdentityDocumentCaptureInitiationInfoReturn Value
identity document capture info
-
Resets any cached data.
Throws
SudoIdentityVerificationClientErrorDeclaration
Swift
func reset() throws -
getIdentityDataProcessingConsentContent(input:Asynchronous) Retrieves the content for identity data processing consent.
Declaration
Swift
func getIdentityDataProcessingConsentContent(input: IdentityDataProcessingConsentContentInput) async throws -> IdentityDataProcessingConsentContentParameters
inputPreferred content type and language (in RFC 5646 format).
Return Value
Consent content.
-
getIdentityDataProcessingConsentStatus()AsynchronousRetrieves the current consent status for identity data processing.
Declaration
Swift
func getIdentityDataProcessingConsentStatus() async throws -> IdentityDataProcessingConsentStatusReturn Value
Consent status.
-
provideIdentityDataProcessingConsent(input:Asynchronous) Provides consent for identity data processing.
Declaration
Swift
func provideIdentityDataProcessingConsent(input: IdentityDataProcessingConsentInput) async throws -> IdentityDataProcessingConsentResponseParameters
inputConsent content, type, and language.
Return Value
Consent response.
-
withdrawIdentityDataProcessingConsent()AsynchronousWithdraws consent for identity data processing.
Declaration
Swift
func withdrawIdentityDataProcessingConsent() async throws -> IdentityDataProcessingConsentResponseReturn Value
Consent response.