AlAccounts

public final class AlAccounts

SDK Initialization object.

shared
AlAccounts object instance.
Declaration
Swift

public static let shared: AlAccounts


                    
                    
                    combine

Futures object instance.

Declaration

Swift

public private(set) lazy var combine: Futures { get set }


                    
                    
                    async

Async object instance.

Declaration

Swift

public private(set) lazy var async: Async { get set }

Accounts


                    
                    
                    listAccounts(token:query:delegate:)

Lists the accounts details, in their current status.

Declaration

Swift

public func listAccounts(
    token: String,
    query: AccountsQuery? = nil,
    delegate: AccountsDelegate)

Parameters

`token`	The token to authenticate the SDK.
`query`	The query.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    getAccount(token:accountUuid:delegate:)

Gets the account details, in its current status.

Declaration

Swift

public func getAccount(
    token: String,
    accountUuid: String,
    delegate: AccountsDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    updateAccount(token:accountUuid:data:delegate:)

Updates an existing account in the system.

Note

If you want to clean a nullable field set the value as an empty String instead of nil. Setting nil will have no effect on the actual value of the field.

Declaration

Swift

public func updateAccount(
    token: String,
    accountUuid: String,
    data: AccountUpdateRequest,
    delegate: AccountsDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`data`	The user data to update an account.
`delegate`	The delegate to receive SDK updates.

Accounts Address


                    
                    
                    listAddresses(token:accountUuid:delegate:)

Gets the list of addresses associated with the account. The primary address is used for Identity Verification processes.

Declaration

Swift

public func listAddresses(
    token: String,
    accountUuid: String,
    delegate: AccountAddressesDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    createAddress(token:accountUuid:data:delegate:)

Creates an address and adds it to the account.

Declaration

Swift

public func createAddress(
    token: String,
    accountUuid: String,
    data: AccountAddressRequest,
    delegate: AccountAddressesDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`data`	User data to create new account.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    updateAddress(token:accountUuid:addressUuid:data:delegate:)

Updates an existing address in the account.

Declaration

Swift

public func updateAddress(
    token: String,
    accountUuid: String,
    addressUuid: String,
    data: AccountAddressRequest,
    delegate: AccountAddressesDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`addressUuid`	The address uuid value.
`data`	Address data to update an address.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    deleteAddress(token:accountUuid:addressUuid:delegate:)

Delete user address.

Declaration

Swift

public func deleteAddress(
    token: String,
    accountUuid: String,
    addressUuid: String,
    delegate: AccountAddressesDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`addressUuid`	The address uuid value.
`delegate`	The delegate to receive SDK updates.

Dossiers


                    
                    
                    registerAccountDossierViewController(token:cameraToken:viewController:data:delegate:style:)

Warning

When providing a AccountDossierData model with the AccountDossierIntent.replace case keep in mind that all previously added documents and the current dossier will be replaced with a new one. Consider using AccountDossierIntent.update if what you want is just update the current documents.

Declaration

Swift

public func registerAccountDossierViewController(
    token: String,
    cameraToken: String,
    viewController: AccountDossierViewController,
    data: AccountDossierCaptureRequest,
    delegate: AccountDossiersDelegate,
    style: AccountDossierStyle? = nil)

Parameters

`token`	The token to authenticate the SDK.
`cameraToken`	The token to authenticate the Camera SDK.
`viewController`	The `AccountDossierViewController` view controller.
`data`	Data model to setup dossier capture.
`delegate`	The delegate to receive SDK updates.
`style`	The style customizations object.


                    
                    
                    createAccountDossierViewController(token:cameraToken:data:delegate:style:)

Create and returns an AccountDossierViewController.

Warning

Declaration

Swift

public func createAccountDossierViewController(
    token: String,
    cameraToken: String,
    data: AccountDossierCaptureRequest,
    delegate: AccountDossiersDelegate,
    style: AccountDossierStyle? = nil)
-> AccountDossierViewController

Parameters

`token`	The token to authenticate the SDK.
`cameraToken`	The token to authenticate the Camera SDK.
`data`	Data model to setup dossier capture.
`delegate`	The delegate to receive SDK updates.
`style`	The style customizations object.

Return Value

A AccountDossierViewController instance.


                    
                    
                    registerCaptureAccountDossierViewController(cameraToken:viewController:data:delegate:style:)

Declaration

Swift

public func registerCaptureAccountDossierViewController(
    cameraToken: String,
    viewController: AccountDossierViewController,
    data: [DocumentType],
    delegate: AccountDossiersCaptureDelegate,
    style: AccountDossierStyle? = nil)

Parameters

`cameraToken`	The token to authenticate the Camera SDK.
`viewController`	The `AccountDossierViewController` view controller.
`data`	Data model to setup dossier capture.
`delegate`	The delegate to receive SDK updates.
`style`	The style customizations object.


                    
                    
                    createCaptureAccountDossierViewController(cameraToken:data:delegate:style:)

Create and returns an AccountDossierViewController.

Declaration

Swift

public func createCaptureAccountDossierViewController(
    cameraToken: String,
    data: [DocumentType],
    delegate: AccountDossiersCaptureDelegate,
    style: AccountDossierStyle? = nil)
-> AccountDossierViewController

Parameters

`cameraToken`	The token to authenticate the Camera SDK.
`data`	Data model to setup dossier capture.
`delegate`	The delegate to receive SDK updates.
`style`	The style customizations object.

Return Value

A AccountDossierViewController instance.


                    
                    
                    createDossier(token:accountUuid:data:delegate:)

Create an account dossier.

Declaration

Swift

public func createDossier(
    token: String,
    accountUuid: String,
    data: AccountDossierRequest,
    delegate: AccountDossiersDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`data`	The data to create an account dossier.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    updateDossier(token:accountUuid:dossierUuid:data:delegate:)

Update an account dossier.

Declaration

Swift

public func updateDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    data: AccountDossierUpdateRequest,
    delegate: AccountDossiersDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`dossierUuid`	The account dossier uuid value.
`data`	The data to update an account dossier.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    replaceDossier(token:accountUuid:dossierUuid:data:delegate:)

Replace an account dossier.

Declaration

Swift

public func replaceDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    data: AccountDossierUpdateRequest,
    delegate: AccountDossiersDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`dossierUuid`	The account dossier uuid value.
`data`	The data to replace an account dossier.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    getDossier(token:accountUuid:dossierUuid:delegate:)

Gets a specific dossier from the account, including the uploaded documents.

Declaration

Swift

public func getDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    delegate: AccountDossiersDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`dossierUuid`	The dossier uuid value.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    listDossiers(token:accountUuid:delegate:)

Gets the account dossiers, including all documents that have been uploaded to this account.

Declaration

Swift

public func listDossiers(
    token: String,
    accountUuid: String,
    delegate: AccountDossiersDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    deleteDossier(token:accountUuid:dossierUuid:delegate:)

Deletes a dossier from the system.

Declaration

Swift

public func deleteDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    delegate: AccountDossiersDelegate)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`dossierUuid`	The dossier uuid value.
`delegate`	The delegate to receive SDK updates.

Async
Async bindings.
See more
Declaration
Swift

public class Async

Accounts


                    
                    
                    listAccounts(token:query:completion:)

Lists the accounts details, in their current status.

Declaration

Swift

func listAccounts(
    token: String,
    query: AccountsQuery? = nil,
    completion: @escaping (Result<[Account], EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`query`	The query.
`completion`	Called when the call was completed.


                    
                    
                    getAccount(token:accountUuid:completion:)

Gets the account details, in its current status.

Declaration

Swift

func getAccount(
    token: String,
    accountUuid: String,
    completion: @escaping (Result<Account, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid value.
`completion`	Called when the call was completed.


                    
                    
                    updateAccount(token:accountUuid:data:completion:)

Updates an existing account in the system.

Note

If you want to clean a nullable field set the value as an empty String instead of nil. Setting nil will have no effect on the actual value of the field.

Declaration

Swift

func updateAccount(
    token: String,
    accountUuid: String,
    data: AccountUpdateRequest,
    completion: @escaping (Result<Account, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`data`	The user data to update an account.
`completion`	Called when the call was completed.

Accounts Address


                    
                    
                    listAddresses(token:accountUuid:completion:)

Gets the list of addresses associated with the account. The primary address is used for Identity Verification processes.

Declaration

Swift

func listAddresses(
    token: String,
    accountUuid: String,
    completion: @escaping (Result<[AccountAddress], EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`completion`	Called when the call was completed.


                    
                    
                    createAddress(token:accountUuid:data:completion:)

Creates an address and adds it to the account.

Declaration

Swift

func createAddress(
    token: String,
    accountUuid: String,
    data: AccountAddressRequest,
    completion: @escaping (Result<AccountAddress, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`data`	User data to create new account.
`completion`	Called when the call was completed.


                    
                    
                    updateAddress(token:accountUuid:addressUuid:data:completion:)

Updates an existing address in the account.

Declaration

Swift

func updateAddress(
    token: String,
    accountUuid: String,
    addressUuid: String,
    data: AccountAddressRequest,
    completion: @escaping (Result<AccountAddress, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`addressUuid`	The address uuid value.
`data`	Address data to update an address.
`completion`	Called when the call was completed.


                    
                    
                    deleteAddress(token:accountUuid:addressUuid:completion:)

Deletes an address from the account.

Declaration

Swift

func deleteAddress(
    token: String,
    accountUuid: String,
    addressUuid: String,
    completion: @escaping (Result<Bool, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`addressUuid`	The address uuid value.
`completion`	Called when the call was completed.

Dossiers


                    
                    
                    createDossier(token:accountUuid:data:completion:)

Create an account dossier.

Declaration

Swift

func createDossier(
    token: String,
    accountUuid: String,
    data: AccountDossierRequest,
    completion: @escaping (Result<AccountDossier, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`data`	The data to create an account dossier.
`completion`	Called when the call was completed.


                    
                    
                    updateDossier(token:accountUuid:dossierUuid:data:completion:)

Update an account dossier.

Declaration

Swift

func updateDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    data: AccountDossierUpdateRequest,
    completion: @escaping (Result<AccountDossier, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`dossierUuid`	The account dossier uuid value.
`data`	The data to update an account dossier.
`completion`	Called when the call was completed.


                    
                    
                    replaceDossier(token:accountUuid:dossierUuid:data:completion:)

Replace an account dossier.

Declaration

Swift

func replaceDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    data: AccountDossierUpdateRequest,
    completion: @escaping (Result<AccountDossier, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`dossierUuid`	The account dossier uuid value.
`data`	The data to replace an account dossier.
`completion`	Called when the call was completed.


                    
                    
                    getDossier(token:accountUuid:dossierUuid:completion:)

Gets a specific dossier from the account, including the uploaded documents.

Declaration

Swift

func getDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    completion: @escaping (Result<AccountDossier, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`dossierUuid`	The dossier uuid value.
`completion`	Called when the call was completed.


                    
                    
                    listDossiers(token:accountUuid:completion:)

Gets the account dossiers, including all documents that have been uploaded to this account.

Declaration

Swift

func listDossiers(
    token: String,
    accountUuid: String,
    completion: @escaping (Result<[AccountDossier], EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`completion`	Called when the call was completed.


                    
                    
                    deleteDossier(token:accountUuid:dossierUuid:completion:)

Deletes a dossier from the system.

Declaration

Swift

func deleteDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    completion: @escaping (Result<Bool, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`dossierUuid`	The dossier uuid value.
`completion`	Called when the call was completed.

Futures
Combine bindings.
See more
Declaration
Swift

public class Futures