Getting Started
Getting you up and running
🙋♂️ How to get access to Akahu APIs
The fastest way to get started is to create a sandboxed personal app. This will grant you instant API access to your own accounts. You can create a personal app at my.akahu.io.
For more details, see our Personal Apps Guide.
🧑💻 API reference
Learn and explore Akahu's various endpoints through our interactive 📖 API docs.
If you prefer Postman, here's a link to our collection 👇
🪄 SDK
Akahu maintains a comprehensive JavaScript SDK that makes working with our API simple and easy.
🧍 Personal app limitations
A personal app is the easiest way to get started using Akahu APIs, however there are several important differences and limitations when compared to a full Akahu app. These are outlined in the table below:
| Personal App | Full App | |
|---|---|---|
| Pricing | Free | Usage based1 |
| User limit | 1 user (restricted to your own Akahu account) | Unlimited |
| Webhooks | ✖️ | ✅ |
| Scheduled refresh cadence | Daily | Customisable2 (default daily) |
| Manual refresh rest period | 1 Hour | Customisable2 (default 15 mins) |
1You won't be billed for a full app during development/testing.
2Changes to default refresh limits may affect pricing.
✨ Full API access
Personal apps are a great way to explore the API and its 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 ID Token and App Secret, follow our OAuth2 Authorization Guide to learn how to request access to user accounts.
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 Akahu-related functionality.
⚡️ Quick start guides
Once you have API access, begin exploring the functionality on offer with our quick start guides. Here are the most popular guides:
-
Accessing Account Data: Learn how to get account data, and how to interpret it.
-
Accessing Transactional Data: Learn how to get transaction data, and how to interpret it. Akahu offers a range of filters to simplify analysis.
-
Payment initiation: Learn how to initiate a payment.
-
Identity and bank account verification: Learn how to use bank data to support KYC and AML processes.
💙 Our team is here to support you
We pride ourselves on being available to support your use of Akahu APIs.
You can join our public Slack community, or contact us via email or phone.
Updated 6 months ago