Data

Request one-off or ongoing access to account data. Aggregate information from bank, investment, KiwiSaver, and other financial accounts.

Account Data GuideTransaction Data Guide

Account balances and metadata

Get one-off or ongoing access to balances and account metadata. This data is standardised across providers and simple to work with.

Commonly used to provide features like net worth tracking, product comparison, and to provide a holistic view of a user's financial life.

Enriched transaction data

Get one-off or ongoing access to transaction data. This data is standardised across providers and enriched with merchant details.

Commonly used in accounting solutions, personal finance tools, and loan applications.

Used by:

Response Sample

Consumers connect their financial accounts to your application via Akahu's OAuth connection flow.

Upon completion of that connection flow, your application holds a user token that enables programmatic interactivity with connected accounts via Akahu's API. The user token is scoped to the specific permissions granted by the consumer.


{
  "_id": "acc_cks9ty1ok000311111111111",
  "connection": {
    "name": "Kiwibank",
    "logo": "https://static.akahu.io/images/conn_cjgaac5at000001qi2yw8ftil_logo.png",
    "_id": "conn_cjgaac5at000001qi2yw8ftil"
  },
  "name": "Joint spending",
  "status": "ACTIVE",
  "formatted_account": "38-9017-0000000-04",
  "meta": {
    "holder": "ARWEN UNDOMIEL",
    "address": "TA 241, Rivendell, 1011, Reunited Kingdom"
  },
  "refreshed": {
    "balance": "2021-11-11T22:15:46.418Z",
    "meta": "2021-11-11T22:15:46.418Z",
    "transactions": "2021-11-11T22:15:50.058Z"
  },
  "balance": {
    "available": 7658.46,
    "currency": "NZD",
    "current": 8413.88,
    "overdrawn": false
  },
  "attributes": [
    "TRANSFER_TO",
    "PAYMENT_TO",
    "PAYMENT_FROM",
    "TRANSFER_FROM",
    "TRANSACTIONS"
  ],
  "type": "CHECKING"
}

Other Use Cases

Payments

Verification

Genie

Transaction Data

Talk with our team

Using the API

Keen to get started right now? Create a personal app which will grant you instant API access to your own accounts.

If you want access to a full app, contact us and we'll set it up.

Get in touch

Contract services

Our team can provide contract services to explore or build the functionality that you have in mind.

We'd love to discuss the options with you.

Get in touch