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.

Personal app limitations

A personal app is the easiest way to get started using the Akahu API, however there are several important differences and limitations when compared to a full Akahu app. These are outlined in the table below:

Personal AppFull App
PricingFreeUsage based1
User limit1 user (restricted to your own Akahu account)Unlimited
Webhooks✖️
Scheduled refresh cadenceDailyCustomisable2 (default daily)
Manual refresh rest period1 HourCustomisable2 (default 15 mins)

1You won't be billed for a full app during development/testing.

2Changes to default refresh limits may affect pricing.

Graduating to a full app

Personal apps are a great way to learn about the API and it's capabilities, but unsuitable for building a production-ready application.

If you want to open your application up to multiple users or use functionality such as webhooks, you will need to apply for a full Akahu app. 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?