Async

class Async

Async bindings.

Accounts

  • 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.

  • 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

Dossiers

  • 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.

  • 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.

  • 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.