Skip to content

A local-first personal finance app

Add Docs page for Akahu Bank Sync (#8145)

ItsThatDudedea4d11f2adb
diff --git a/packages/docs/docs-sidebar.js b/packages/docs/docs-sidebar.js
index 2b2ea85605..79f9d2a79d 100644
--- a/packages/docs/docs-sidebar.js
+++ b/packages/docs/docs-sidebar.js
@@ -171,6 +171,7 @@ const sidebars = {
id: 'advanced/bank-sync',
},
items: [
+ 'advanced/bank-sync/akahu',
'advanced/bank-sync/enable-banking',
'advanced/bank-sync/gocardless',
'advanced/bank-sync/simplefin',
diff --git a/packages/docs/docs/advanced/bank-sync.md b/packages/docs/docs/advanced/bank-sync.md
index dc24b95b73..4667a4b254 100644
--- a/packages/docs/docs/advanced/bank-sync.md
+++ b/packages/docs/docs/advanced/bank-sync.md
@@ -13,6 +13,7 @@ Here are a couple of considerations to know about before making the decision to
## Supported Providers
+- [Akahu](./bank-sync/akahu.md) (New Zealand Banks)
- [Enable Banking](./bank-sync/enable-banking.md) (European Banks)
- GoCardless [BankAccountData](./bank-sync/gocardless.md) (European Banks, **not accepting new accounts**)
- [SimpleFIN Bridge](./bank-sync/simplefin.md) (North American Banks)
diff --git a/packages/docs/docs/advanced/bank-sync/akahu.md b/packages/docs/docs/advanced/bank-sync/akahu.md
new file mode 100644
index 0000000000..9810a513d0
--- /dev/null
+++ b/packages/docs/docs/advanced/bank-sync/akahu.md
@@ -0,0 +1,26 @@
+# Akahu Setup
+
+<ExperimentalFeatureWarning issueId="8020" />
+
+:::warning
+All functionality described here may not be available in the latest stable release. See [Experimental Features](../../experimental/index.md) for instructions to enable experimental features. Use the `nightly` images for the latest implementation.
+:::
+
+### Set up Akahu account
+
+To set up Akahu Bank Sync, start by creating and signing in to your Akahu account: https://my.akahu.nz/
+
+Make sure to link a bank account and then go to the developers page https://my.akahu.nz/developers and get your **APP ID Token** and **User Access Token**
+
+:::note
+If you have not yet created a personal app, you will need to agree to Akahu's Developer Terms and click the button labeled "Continue".
+You will then need to complete identity verification and set up multi-factor authentication.
+
+Once you have completed these steps your app will be created and your User Access Token and App ID Token will be shown to you.
+:::
+
+### Link account with Akahu
+
+In Actual Budget, Go to **More → Bank Sync**, in the **Akahu** card, click **Set up** and paste in the App ID and User Access Tokens.
+
+From the same Bank Sync screen, click on **Link bank account** under the **Akahu** card and follow the prompts to link your account.