Futures

public class Futures

Combine bindings.

Accounts

  • Lists the accounts details, in their current status.

    Declaration

    Swift

    public func listAccounts(
    token: String,
    query: AccountsQuery? = nil) -> Future<[Account], EventError>

    Parameters

    token

    The token to authenticate the SDK.
    query

    The query.

    Return Value

    A Future object.

  • Gets the account details, in its current status.

    Declaration

    Swift

    public func getAccount(
    token: String,
    accountUuid: String) -> Future<Account, EventError>

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.

    Return Value

    A Future object.

  • 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) -> Future<Account, EventError>

    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 Future object.

Accounts Address

  • 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)
-> Future<[AccountAddress], EventError>

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.

    Return Value

    A Future object.

  • Creates an address and adds it to the account.

    Declaration

    Swift

    public func createAddress(
    token: String,
    accountUuid: String,
    data: AccountAddressRequest)
-> Future<AccountAddress, EventError>

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.
    data

    Address data to create new account.

    Return Value

    A Future object.

  • Updates an existing address in the account.

    Declaration

    Swift

    public func updateAddress(
    token: String,
    accountUuid: String,
    addressUuid: String,
    data: AccountAddressRequest)
-> Future<AccountAddress, EventError>

    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 Future object.

  • Deletes an address from the account.

    Declaration

    Swift

    public func deleteAddress(
    token: String,
    accountUuid: String,
    addressUuid: String)
-> Future<Bool, EventError>

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.
    addressUuid

    The address uuid value.

    Return Value

    A Future object.

Dossiers

  • Create an account dossier.

    Declaration

    Swift

    public func createDossier(
    token: String,
    accountUuid: String,
    data: AccountDossierRequest)
-> Future<AccountDossier, EventError>

    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 Future object.

  • Update an account dossier.

    Declaration

    Swift

    public func updateDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    data: AccountDossierUpdateRequest)
-> Future<AccountDossier, EventError>

    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 Future object.

  • Replace an account dossier.

    Declaration

    Swift

    public func replaceDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    data: AccountDossierUpdateRequest)
-> Future<AccountDossier, EventError>

    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 Future object.

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

    Declaration

    Swift

    public func getDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String)
-> Future<AccountDossier, EventError>

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.
    dossierUuid

    The dossier uuid value.

    Return Value

    A Future object.

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

    Declaration

    Swift

    public func listDossiers(
    token: String,
    accountUuid: String)
-> Future<[AccountDossier], EventError>

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.

    Return Value

    A Future object.

  • Deletes a dossier from the system.

    Declaration

    Swift

    public func deleteDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String)
-> Future<Bool, EventError>

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.
    dossierUuid

    The dossier uuid value.

    Return Value

    A Future object.