Getting Started

Getting you up and running

How to get access to the Akahu API

In order to get you up and running as quickly as possible, Akahu offers sandboxed personal apps. These can be created on your personal my.akahu.io apps page, and grant you instant access to your own data via the Akahu API.

For more details, see our Personal Apps Guide.

Graduating to a full app

Personal apps have a number of limitations:

  • Only one user
  • Infrequent data refreshes
  • No webhooks
  • Full access to your accounts and data (this poses a security/privacy risk if your access token is stolen)

These are fine while you are learning about the API and it's capabilities, but become a problem in the context of production-ready applications.

At this point you will want to apply for a full Akahu app, which will allow you to fine tune your permissions and restrictions. You can do this by contacting us on Slack or at [email protected].

Once you have your app token and secret, follow our OAuth2 Authorization Guide to learn how to request access to user accounts and data.

πŸ“˜

Accreditation

Before you can release an Akahu integration to production, your product must complete our Accreditation Process. We recommend that you familiarise yourself with our accreditation requirements as early as possible to ensure that there are no surprises when it comes time to release your integration.

Quick start guides

Once you have API access, begin exploring the functionality on offer with the following quick start guides:

Learn how to get account data with a simple API call.

Much like account data, accessing transactional data is simple. Akahu offers a range of filters to simplify analysis.

Learn how to make a transfer and follow it's progress until funds are received.

Learn how to send money to a third-party bank account using the Akahu API.


Did this page help you?