Async

public class Async

Async bindings.

Accounts


                    
                    
                    listAccounts(token:query:)

Asynchronous

Lists the accounts details, in their current status.

Declaration

Swift

public func listAccounts(
    token: String,
    query: AccountsQuery? = nil) async throws -> [Account]

Parameters

`token`	The token to authenticate the SDK.
`query`	The query.

Return Value

A Account array.


                    
                    
                    getAccount(token:accountUuid:)

Asynchronous

Gets the account details, in its current status.

Declaration

Swift

public func getAccount(
    token: String,
    accountUuid: String)
async throws -> Account

Parameters

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

Return Value

A Account object.


                    
                    
                    updateAccount(token:accountUuid:data:)

Asynchronous

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)
async throws -> Account

Parameters

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

Return Value

A Account object.

Accounts Address


                    
                    
                    listAddresses(token:accountUuid:)

Asynchronous

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)
async throws -> [AccountAddress]

Parameters

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

Return Value

A AccountAddress array.


                    
                    
                    createAddress(token:accountUuid:data:)

Asynchronous

Creates an address and adds it to the account.

Declaration

Swift

public func createAddress(
    token: String,
    accountUuid: String,
    data: AccountAddressRequest)
async throws -> AccountAddress

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`data`	Address data to create new account.

Return Value

A AccountAddress object.


                    
                    
                    updateAddress(token:accountUuid:addressUuid:data:)

Asynchronous

Updates an existing address in the account.

Declaration

Swift

public func updateAddress(
    token: String,
    accountUuid: String,
    addressUuid: String,
    data: AccountAddressRequest)
async throws -> AccountAddress

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.

Return Value

A AccountAddress object.


                    
                    
                    deleteAddress(token:accountUuid:addressUuid:)

Asynchronous

Deletes an address from the account.

Declaration

Swift

public func deleteAddress(
    token: String,
    accountUuid: String,
    addressUuid: String)
async throws -> Bool

Parameters

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

Return Value

True if successful.

Dossiers


                    
                    
                    createDossier(token:accountUuid:data:)

Asynchronous

Create an account dossier.

Declaration

Swift

public func createDossier(
    token: String,
    accountUuid: String,
    data: AccountDossierRequest)
async throws -> AccountDossier

Parameters

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

Return Value

A AccountDossier object.


                    
                    
                    updateDossier(token:accountUuid:dossierUuid:data:)

Asynchronous

Update an account dossier.

Declaration

Swift

public func updateDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    data: AccountDossierUpdateRequest)
async throws -> AccountDossier

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.

Return Value

A AccountDossier object.


                    
                    
                    replaceDossier(token:accountUuid:dossierUuid:data:)

Asynchronous

Replace an account dossier.

Declaration

Swift

public func replaceDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    data: AccountDossierUpdateRequest)
async throws -> AccountDossier

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.

Return Value

A AccountDossier object.


                    
                    
                    getDossier(token:accountUuid:dossierUuid:)

Asynchronous

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

Declaration

Swift

public func getDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String)
async throws -> AccountDossier

Parameters

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

Return Value

A AccountDossier object.


                    
                    
                    listDossiers(token:accountUuid:)

Asynchronous

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

Declaration

Swift

public func listDossiers(
    token: String,
    accountUuid: String)
async throws -> [AccountDossier]

Parameters

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

Return Value

A AccountDossier array.


                    
                    
                    deleteDossier(token:accountUuid:dossierUuid:)

Asynchronous

Deletes a dossier from the system.

Declaration

Swift

public func deleteDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String)
async throws -> Bool

Parameters

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

Return Value

True if successful.