SpareSpare Docs
GuidesAPI Reference

Account Information

Read a customer's accounts, balances, and transactions from their bank, securely, with their consent.

Account Information Services (AIS) give your application read access to a customer's bank data, accounts, balances, transactions, and statements, once the customer authorizes it. It's the data side of open banking, alongside payment initiation.

In this guide

  • What data AIS exposes (accounts, balances, transactions, statements)
  • The consent + connection model that authorizes access
  • How a customer authorizes read access at their bank
  • Where each data object is documented

Availability

Availability varies by market, see Coverage for what's enabled for your integration.

What you can read

DataDescription
AccountsThe customer's accounts, current, savings, cards, loans, investments, with identifiers and metadata
BalancesPoint-in-time balances (available, credit, reserved, etc.) per account
TransactionsDetailed movements, credits and debits with dates, amounts, parties, and codes
StatementsPDF statements generated from the underlying transaction and balance data

AIS access is gated by the customer's consent, granted through a connection to their bank:

  1. Your application requests access for a set of data permissions.
  2. The customer authorizes read access at their bank (hosted by Spare Link or your own flow).
  3. Spare establishes a connection and returns a consent your app references on each data call.
  4. You query accounts, balances, and transactions for the life of that consent.

Consent is a separate authorization from payment initiation, reading data and moving money are distinct permissions. See Consent Lifecycle for states and renewal.

Data objects

Key takeaways

  • AIS is read-only access to accounts, balances, transactions, and statements, gated by customer consent.
  • Consent for data is separate from consent for payments.
  • A connection to the customer's bank authorizes access; your app references the resulting consent on every data call.

On this page