AlAccounts

public final class AlAccounts : Sendable

SDK Initialization object.

  • AlAccounts object instance.

    Declaration

    Swift

    public static let shared: AlAccounts

Accounts

  • Lists the accounts details, in their current status.

    Declaration

    Swift

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

    Parameters

    token

    The token to authenticate the SDK.
    query

    The query.

    Return Value

    An Account list.

  • Gets the account details, in its current status.

    Declaration

    Swift

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

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.

    Return Value

    An Account.

  • 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(ALEventError) -> 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

    An Account.

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

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.

    Return Value

    An AccountAddress list.

  • Creates an address and adds it to the account.

    Declaration

    Swift

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

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.
    data

    User data to create new account.

    Return Value

    An AccountAddress.

  • Updates an existing address in the account.

    Declaration

    Swift

    public func updateAddress(
    token: String,
    accountUuid: String,
    addressUuid: String,
    data: AccountAddressRequest
) async throws(ALEventError) -> 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

    An AccountAddress.

  • Delete user address.

    Declaration

    Swift

    public func deleteAddress(
    token: String,
    accountUuid: String,
    addressUuid: String
) async throws(ALEventError)

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.
    addressUuid

    The address uuid value.

Dossiers

  • Create an account dossier.

    Declaration

    Swift

    public func createDossier(
    token: String,
    accountUuid: String,
    data: AccountDossierRequest
) async throws(ALEventError) -> 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

    An AccountDossier.

  • Update an account dossier.

    Declaration

    Swift

    public func updateDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    data: AccountDossierUpdateRequest
) async throws(ALEventError) -> 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

    An AccountDossier.

  • Replace an account dossier.

    Declaration

    Swift

    public func replaceDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String,
    data: AccountDossierUpdateRequest
) async throws(ALEventError) -> 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

    An AccountDossier.

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

    Declaration

    Swift

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

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.
    dossierUuid

    The dossier uuid value.

    Return Value

    An AccountDossier.

  • 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(ALEventError) -> [AccountDossier]

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.

    Return Value

    An AccountDossier list.

  • Deletes a dossier from the system.

    Declaration

    Swift

    public func deleteDossier(
    token: String,
    accountUuid: String,
    dossierUuid: String
) async throws(ALEventError)

    Parameters

    token

    The token to authenticate the SDK.
    accountUuid

    The user account uuid value.
    dossierUuid

    The dossier uuid value.

  • UI.

    See more

    Declaration

    Swift

    final class UserInterface : Sendable

  • UI object instance.

    Declaration

    Swift

    static let userInterface: UserInterface