SpareSpare Docs
GuidesAPI Reference

Account Information

Read a customer's bank data through account access, authorization, and optional risk reports.

Account Information Services (AIS) let your application read a customer's bank data once they authorize access. In the UAE, the flow runs through providers, account access, bank authorization, and optionally a risk report.

In this guide

  • The four-step UAE AIS flow (providers β†’ account access β†’ authorize β†’ report)
  • How data permissions and consent expiry are declared on Create Account Access
  • When to poll risk report status

Availability

Account Information is live for the UAE tenant. See Coverage for sandbox access and subscription requirements.

What you can access

The requestedPermissions you send on Create Account Access define the data slices the customer must approve, for example accounts, balances, and transactions. After they authorize at their bank, you can generate a risk report for that customer.

The four-step flow

  1. Providers. List live banks for the UAE (GET /providers?countryCode=AE).
  2. Account access. Create the request and consent in one call (POST /data/account-access).
  3. Authorization. Send the customer to the authorizationLink. They approve access at their bank. Spare completes the bank callback.
  4. Risk report (optional). Generate a scored report or PDF export (POST /report/risk-reports with referenceCustomerId).

Account requests (POST /data/account-requests), POST /consent/account, and sync jobs remain on the contract for the longer path. The integration guide uses Create Account Access.

Consent for reading data is separate from consent for payment initiation. See Consent Lifecycle for status values that apply across both.

Key takeaways

  • UAE AIS is read-only bank data access, gated by customer consent on a declared permission set.
  • Integrate over REST today: list providers, create account access, customer authorization at the bank, then optional risk reporting.
  • Poll report status until the asynchronous report step completes.

On this page