# Akahu Documentation

> Akahu provides open finance infrastructure for New Zealand.

## Guides: Guides
- [Getting Started](https://developers.akahu.nz/docs/getting-started.md): Getting you up and running
- [Personal Apps](https://developers.akahu.nz/docs/personal-apps.md): Get started with the Akahu API using a personal app
  - [Personal Apps - Advanced](https://developers.akahu.nz/docs/personal-apps-advanced.md): Learn more about the settings and security features of personal apps
- [App Accreditation](https://developers.akahu.nz/docs/app-accreditation.md): This guide describes Akahu's accreditation requirements and process
- [Best Practices](https://developers.akahu.nz/docs/best-practices.md): Recommendations for building a high quality integration with Akahu
- [Transitioning to Official Open Banking](https://developers.akahu.nz/docs/official-open-banking.md)
  - [Frequently Asked Questions](https://developers.akahu.nz/docs/official-open-banking-faqs.md)
  - [OAuth Authorisation Flow](https://developers.akahu.nz/docs/official-open-banking-oauth.md)
  - [Feature Support](https://developers.akahu.nz/docs/official-open-banking-feature-support.md)
    - [Account Types](https://developers.akahu.nz/docs/official-open-banking-feature-support-accounts.md)
    - [Connection Management](https://developers.akahu.nz/docs/official-open-banking-feature-support-connection-management.md)
    - [Account information](https://developers.akahu.nz/docs/official-open-banking-feature-support-data.md)
    - [Enduring Payments](https://developers.akahu.nz/docs/official-open-banking-feature-support-payments.md)
  - [Migration](https://developers.akahu.nz/docs/official-open-banking-migration.md)
  - [Enduring Payments](https://developers.akahu.nz/docs/official-open-banking-payments.md)
- [Authorising With OAuth2](https://developers.akahu.nz/docs/authorizing-with-oauth2.md): Requesting access to a user's financial accounts
  - [Anatomy of an Authorisation Request](https://developers.akahu.nz/docs/authorisation-request-anatomy.md): Configure the type and scope of access that is requested by your application
- [Accessing Account Data](https://developers.akahu.nz/docs/accessing-account-data.md): Learn how to access a connected user's account data
- [Accessing Transactional Data](https://developers.akahu.nz/docs/accessing-transactional-data.md): Learn how to access a connected user's transactional data
- [Data Refreshes](https://developers.akahu.nz/docs/data-refreshes.md): Learn about how Akahu keeps connected account data up-to-date
- [Enduring Payments](https://developers.akahu.nz/docs/enduring-payments.md): Initiate payments on an ongoing basis
  - [Requesting Payment Consent](https://developers.akahu.nz/docs/enduring-payments-authorisation.md): Request and authorise an enduring payment consent
  - [Making a Payment](https://developers.akahu.nz/docs/making-a-payment.md): Learn how to make a payment from a user's account
- [One-Off Payments](https://developers.akahu.nz/docs/oneoff-payments.md): Initiate single payments using regulated open banking providers
  - [Making a One-Off Payment](https://developers.akahu.nz/docs/oneoff-payments-making-a-payment.md): Create a one-off payment, allowing a user to pay to your specified destination.
  - [One-Off Payment Lifecycle](https://developers.akahu.nz/docs/oneoff-payments-lifecycle.md): Understand the different states a payment can pass through as it is paid
  - [Monitoring One-Off Payment Progress](https://developers.akahu.nz/docs/oneoff-payments-monitoring-progress.md): Monitor a payment as it progresses to a terminal state
- [Payee Verification](https://developers.akahu.nz/docs/payee-verification.md): How Akahu confirms that payee details are correct
- [Identity Verification](https://developers.akahu.nz/docs/identity-verification.md): Akahu provides two different ways to verify customer identity.
  - [One-Off Identity Verification](https://developers.akahu.nz/docs/oneoff-identity-verification.md): Learn how to access identity information using Akahu's one-off flow.
  - [One-Off Verify Name](https://developers.akahu.nz/docs/oneoff-verify-name.md): Learn how to verify names using Akahu's one-off flow.
  - [Enduring Identity Verification](https://developers.akahu.nz/docs/enduring-identity-verification.md): Learn how to access identity information from an enduring access flow.
  - [Enduring Verify Name](https://developers.akahu.nz/docs/enduring-verify-name.md): Learn how to verify names using Akahu's enduring access flow.
- [Enriching Transactions with Genie](https://developers.akahu.nz/docs/genie.md): Use the Genie Search API to enrich transactions
- [Demo Bank](https://developers.akahu.nz/docs/demo-bank.md): Find out how to use Akahu's Demo Bank to test your integration

## Guides: Reference
- [Enduring API Webhooks](https://developers.akahu.nz/docs/reference-webhooks.md): Best practices for setting up your app to receive webhooks from the Akahu enduring API
- [Scopes](https://developers.akahu.nz/docs/scopes.md): Akahu's permission system
- [Supported Integrations](https://developers.akahu.nz/docs/integrations.md): Akahu supports integrations with many 3rd parties
- [Response Formats](https://developers.akahu.nz/docs/response-formatting.md): Akahu returns API responses in a standard format, described here.
- [Rate Limits](https://developers.akahu.nz/docs/reference-rate-limits.md): High API request volumes may be rate-limited by Akahu
- [Idempotent Requests](https://developers.akahu.nz/docs/idempotent-requests.md): Akahu can enforce idempotency on all POST endpoints by adding a simple header
- [The Account Model](https://developers.akahu.nz/docs/the-account-model.md): The lowdown on how accounts are structured and what each key means.
- [The Transaction Model](https://developers.akahu.nz/docs/the-transaction-model.md): The lowdown on how transactions are structured and what each key means.
- [The Oneoff Identity Result](https://developers.akahu.nz/docs/the-oneoff-identity-result-model.md): Interpreting the result from the `/identity` endpoint.

## Guides: Akahu Apply API
- [Getting Started](https://developers.akahu.nz/docs/akahu-apply-getting-started.md): Getting started with the Akahu Apply API
- [Key concepts](https://developers.akahu.nz/docs/akahu-apply-key-concepts.md): Learn about important concepts for working with the Akahu Apply API
- [Workflows](https://developers.akahu.nz/docs/akahu-apply-workflows.md): Common workflows for Akahu Apply
- [Categorisation](https://developers.akahu.nz/docs/akahu-apply-categorisation.md): Categorisation available via Akahu Apply
- [Insights](https://developers.akahu.nz/docs/akahu-apply-insights.md): Insights generated by Akahu Apply
- [Reports](https://developers.akahu.nz/docs/akahu-apply-reports.md): Details regarding report processing
- [Referrals](https://developers.akahu.nz/docs/akahu-apply-referrals.md): Share data between organisations using Akahu Apply referrals
- [Webhooks](https://developers.akahu.nz/docs/akahu-apply-webhooks.md): Receive events from Akahu Apply as applications, documents, and reports change

## API Reference: Akahu Enduring API
- [Introduction](https://developers.akahu.nz/reference/api-akahu-io-introduction.md): Get enduring access to a user's financial accounts
- [Authentication](https://developers.akahu.nz/reference/api-akahu-io-authentication.md): How to authenticate with Akahu's API
- Auth
  - [Exchange an Authorization Code](https://developers.akahu.nz/reference/post_token.md): This endpoint is the final step in our [📖 OAuth Authentication Flow](/docs/authorizing-with-oauth2).  Use this endpoint to exchange an **Authorization Code** for a **User Access Token**, which can be…
  - [Revoke a token](https://developers.akahu.nz/reference/delete_token.md): Revokes the **User Access Token** that is included in the `Authorization` header of the request.  Revoking a User Access Token will remove your access to **all** of a user's connected account data…
  - [Create a pushed authorisation request](https://developers.akahu.nz/reference/post_par.md)
- Accounts
  - [List all accounts](https://developers.akahu.nz/reference/get_accounts.md): Get a list of all accounts that the user has connected to your application.  > ℹ️ > > The format for the returned account depends on the permissions you have!  For more details see:   - [📚 Accessing…
  - [Get account](https://developers.akahu.nz/reference/get_accounts-id.md): Get an individual account that the user has connected to your application.  > ℹ️ > > The format for the returned account depends on the permissions you have!  For more details see:   - [📚 Accessing…
  - [Get account verification token](https://developers.akahu.nz/reference/get_accounts-id-verification-token.md): Get an account verification token for an account so it can be used as a payee in either a one-off payment or enduring payment consent request.  Account verification tokens can only be generated for…
  - [Revoke access to account](https://developers.akahu.nz/reference/delete_accounts-id-verification-token.md): > ⚠️ > > This endpoint is deprecated. > <pre></pre> > Accounts connected via an official open banking connection can't be revoked on an individual basis via API. Calling this endpoint for accounts…
  - [Revoke a payment consent](https://developers.akahu.nz/reference/delete_accounts-id-payment-consents-consent-id.md): Revoke one of the enduring payment consents granted for an account.  You can find the `_id` of a consent by looking at the `payment_consents` array on the [account](/reference/get_accounts-id) it…
- Authorisations
  - [Revoke access to authorisation](https://developers.akahu.nz/reference/delete_authorisations-id.md): A user's accounts are connected to Akahu via an authorisation with their financial institution. Multiple accounts can be connected using a single authorisation.  This endpoint will revoke your…
- Categories
  - [Get all categories](https://developers.akahu.nz/reference/get_categories.md): > ⚠️ > > **Authentication** > This endpoint requires [app-scoped](/reference/api-akahu-io-authentication#app-scoped-endpoints) authentication.  Gets a list of all NZFCC categories that may be…
  - [Get category](https://developers.akahu.nz/reference/get_categories-id.md): > ⚠️ > > **Authentication** > This endpoint requires [app-scoped](/reference/api-akahu-io-authentication#app-scoped-endpoints) authentication.  Get an individual NZFCC Category.  - [📚 Explore NZFCC…
- Connections
  - [Get all connections](https://developers.akahu.nz/reference/get_connections.md): > ⚠️ > > **Authentication** > This endpoint requires [app-scoped](/reference/api-akahu-io-authentication#app-scoped-endpoints) authentication.  Gets a list of all connected financial institutions…
  - [Get a connection](https://developers.akahu.nz/reference/get_connections-id.md): > ⚠️ > > **Authentication** > This endpoint requires [app-scoped](/reference/api-akahu-io-authentication#app-scoped-endpoints) authentication.  Get an individual financial institution connection.  -…
- Data Refresh
  - [Refresh all accounts](https://developers.akahu.nz/reference/post_refresh.md): This endpoint requests a data refresh for all accounts that the user has connected to your application.  Account data such as balance and transactions are periodically refreshed by Akahu and enriched…
  - [Refresh Individual Accounts or Connections](https://developers.akahu.nz/reference/post_refresh-id.md): This endpoint requests a data refresh for a specific financial institution or a specific account that the user has connected to your application.  #### Connection ID  Calling this endpoint with a…
- Identity
  - [[One-off access] Get identity result](https://developers.akahu.nz/reference/get_identity-id.md): > ⚠️ > > **Authentication** > This endpoint requires [app-scoped](/reference/api-akahu-io-authentication#app-scoped-endpoints) authentication.  Get the results of an Identity OAuth result using the…
  - [[One-off access] Verify a name](https://developers.akahu.nz/reference/post_identity-id-verify-name.md): > ⚠️ > > **Authentication** > This endpoint requires [app-scoped](/reference/api-akahu-io-authentication#app-scoped-endpoints) authentication.  To verify your user's identity, you may wish to match…
  - [[Enduring access] Verify a name](https://developers.akahu.nz/reference/post_verify-name.md): To verify your user's identity, you may wish to match the name that you have on file against an official record such as the bank account holder name or Party name.  This will match against all…
  - [[Enduring access] Verify a name against an account](https://developers.akahu.nz/reference/post_verify-name-id.md): To verify your user's identity, you may wish to match the name that you have on file against an official record such as the bank account holder name or Party name.  This will only use identity…
  - [[Enduring access] Get user identity data](https://developers.akahu.nz/reference/get_parties.md): Get a list of the parties who have authorised financial account connections with your app. This data is sourced from the customer profile information held by the financial institution rather than any…
- Payments
  - [List payments](https://developers.akahu.nz/reference/get_payments.md): Get a list of the payments that your application has initiated on behalf of the user within the `start` and `end` time range.  >️ ℹ️ Time range defaults to the last 30 days.  For more details about…
  - [Make a payment](https://developers.akahu.nz/reference/post_payments.md): Initiate a payment from the user's connected bank account to another New Zealand bank account.  The payee bank account is not required to be connected to Akahu.  For more details about payments see:…
  - [Make a payment to IRD](https://developers.akahu.nz/reference/post_payments-ird.md): Initiate a tax payment from user's connected bank account to [🔗 Inland Revenue Department](https://www.ird.govt.nz/).  For more details about payments see:   - [📚 Making a payment…
  - [Get a payment](https://developers.akahu.nz/reference/get_payments-id.md): Get an individual payment that your application has initiated on behalf of the user.  For more details about payments see:   - [📖 Making a payment guide](/docs/making-a-payment)   - [📚 Payment…
- Transactions
  - [Get transactions](https://developers.akahu.nz/reference/get_transactions.md): Get a list of the user's transactions within the `start` and `end` time range.  This endpoint returns **settled**\* transactions for all accounts that the user has connected to your application. See…
  - [Get pending transactions](https://developers.akahu.nz/reference/get_transactions-pending.md): Get a list of pending transactions from a user's connected accounts.  This endpoint returns pending transactions from all of a user's accounts that the user has connected to your application.…
  - [Get a transaction by ID](https://developers.akahu.nz/reference/get_transactions-id.md): Get a single transaction from one of the user's connected accounts.  - Transactions will look different depending on your app's permissions. - All times on the transaction are in **UTC**.  For more…
  - [Get transactions by account](https://developers.akahu.nz/reference/get_accounts-id-transactions.md): Get a list of the user's transactions for a specific connected account within the `start` and `end` time range.  This endpoint returns **settled** transactions. See [`GET…
  - [Get pending transactions by account](https://developers.akahu.nz/reference/get_accounts-id-transactions-pending.md): Get a list of the user's pending transactions for a specific connected account.  Pending transactions are not stable (eg. the date or description may change) due to the unreliable nature of the…
  - [Get transactions by IDs](https://developers.akahu.nz/reference/post_transactions-ids.md): Gets a list of the user's transactions that match the provided list of Akahu transaction identifiers.  The intended use for this endpoint is to assist in [📖 transaction…
- Me
  - [Get current user](https://developers.akahu.nz/reference/get_me.md): Get information about the Akahu user and the access they have provided.  > ℹ️ > > The `email` key will only be visible if you have the required permissions.
- Webhooks
  - [Get all webhooks](https://developers.akahu.nz/reference/get_webhooks.md): Gets the active webhook subscriptions that your app has created for the user.  For more details about webhooks see:   - [📖 Webhooks reference](/docs/reference-webhooks)   - [📖 Webhooks…
  - [Subscribe to webhook](https://developers.akahu.nz/reference/post_webhooks.md): > ℹ️ > > Akahu's webhooks are unusual in that they need to be initialised **per user**, requiring a new webhook subscription for each event type you wish to receive for each user.  Register a new…
  - [Get public key](https://developers.akahu.nz/reference/get_keys-id.md): > ⚠️ > > **Authentication** > This endpoint requires [app-scoped](/reference/api-akahu-io-authentication#app-scoped-endpoints) authentication.  Get one of the public keys that Akahu uses to sign…
  - [Unsubscribe from webhook](https://developers.akahu.nz/reference/delete_webhooks-id.md): Delete a webhook subscription that your application has previously created for the user.  For more details about webhooks see:   - [📖 Webhooks reference](/docs/reference-webhooks)   - [📖 Webhooks…
  - [Get webhook events](https://developers.akahu.nz/reference/get_webhook-events.md): > ⚠️ > > **Authentication** > This endpoint requires [app-scoped](/reference/api-akahu-io-authentication#app-scoped-endpoints) authentication.  Returns a list of webhook events that have been…
- Support
  - [Transaction support](https://developers.akahu.nz/reference/post_support-transaction-id.md): Let us know when we get something wrong 🙏. The request body should match the type of request you are making:  ### Notify Us Of A Duplicate ###  | Parameter  | Example                             |…

## API Reference: Akahu One-Off Account Information API
- [Introduction](https://developers.akahu.nz/reference/api-oneoff-akahu-io-introduction.md): Get one-off access to a user's account data
- [Authentication](https://developers.akahu.nz/reference/api-oneoff-akahu-io-authentication.md): Authenticate with Akahu's one-off API using Basic HTTP authentication
- Status
  - [Get Result Status](https://developers.akahu.nz/reference/get_status-code.md): Get the current status of the one-off data retrieval process.  Your application should poll this endpoint to check the status of the result processing before fetching data from other endpoints. Use…
- Parties
  - [Get Parties](https://developers.akahu.nz/reference/get_parties-code.md): Get identity data related to the registered party at the institution that the user has shared data from. This data is sourced from the profile information at the connected institution rather than any…
- PDFs
  - [Get PDF Transaction Exports](https://developers.akahu.nz/reference/get_pdfs-exports-code.md): Get a list of PDF transaction exports for accounts that the user has shared with your application.
  - [Get PDF Statements](https://developers.akahu.nz/reference/get_pdfs-statements-code.md): Get a list of PDF statements for accounts that the user has shared with your application.
- Accounts
  - [Get Accounts](https://developers.akahu.nz/reference/get_accounts-code.md): Get a list of the accounts that the user has shared with your application.  > ℹ️ > > The format for the returned account depends on the permissions you have!  > ℹ️ > > The **one-off** API account…
- Transactions
  - [Get Transactions](https://developers.akahu.nz/reference/get_transactions-code.md): Get a list of the user's transactions from the accounts that they have shared with your application.  Transactions are returned in descending date order in [🔗…
- Identity
  - [Verify your user's name](https://developers.akahu.nz/reference/post_identity-code-verify-name.md): To verify your user's identity, you may wish to match the name that you have on file against an official record such as the bank account holder name or Party name.  For more details about the data…

## API Reference: Akahu One-Off Payments API
- Payments
  - [Create one-off payment](https://developers.akahu.nz/reference/createoneoffpayment.md): Akahu's one-off payment service uses official open banking connections to initiate payments directly from your users' New Zealand bank accounts.  Create a payment by specifying the amount, payee…
  - [Get one-off payment](https://developers.akahu.nz/reference/getoneoffpayment.md)
  - [Cancel pending one-off payment](https://developers.akahu.nz/reference/canceloneoffpayment.md): Note that cancellation is only possible before the payment is authorised (while it's status is `READY`).  Upon cancellation payments will not be processed and the user will be  directed back to the…
- Webhooks
  - [Get webhook signing key](https://developers.akahu.nz/reference/getwebhooksigningkey.md): Retrieve a webhook public signing key by ID, in PEM format.  The IDs used for this endpoint are supplied in the `x-akahu-payments-signing-key` header on webhook requests.  This key can be used to…
- Connections
  - [Get available connections](https://developers.akahu.nz/reference/getconnections.md): Get the financial institution connections available to this application for one-off payments.

## API Reference: Akahu Apply API
- [Introduction](https://developers.akahu.nz/reference/api-apply-akahu-nz-introduction.md): Akahu Apply API reference
- Orgs
  - [Get current org](https://developers.akahu.nz/reference/getcurrentorg.md): Details about the Akahu Apply org that this API key belongs to.
- Applications
  - [Create application](https://developers.akahu.nz/reference/createapplication.md)
  - [Get application](https://developers.akahu.nz/reference/getapplication.md)
  - [Update application](https://developers.akahu.nz/reference/updateapplication.md)
  - [Archive application](https://developers.akahu.nz/reference/archiveapplication.md): An archived application can no longer have additional resources added to it.  Once archived, an application will be securely deleted after a preset number of days, which can be configured by an Akahu…
  - [Restore application](https://developers.akahu.nz/reference/unarchiveapplication.md): If you find you want to add additional data to an archived application, it can be restored from archive.
- Referrals
  - [Create referral](https://developers.akahu.nz/reference/createreferral.md): Create an application snapshot with a code that can be redeemed by another organisation to create a new application with the same data.
  - [List referrals](https://developers.akahu.nz/reference/listreferrals.md): List the referrals that have been created from an application.
  - [Get referral](https://developers.akahu.nz/reference/getreferral.md): Get the redemption code and expiry for a referral.
  - [Revoke referral](https://developers.akahu.nz/reference/revokereferral.md): Revoke a referral so that its code can no longer be redeemed. Revocation is permanent.  Organisations that have previously redeemed the referral keep their copies of the application data.
  - [Redeem referral](https://developers.akahu.nz/reference/createreferralredemption.md): Redeem a referral code into a new application.  Referral redemption is asynchronous. The response includes a redemption ID and processing status. Poll `GET /v1/referral-redemptions/{redemptionId}`…
  - [Get redemption status](https://developers.akahu.nz/reference/getreferralredemption.md): Get the current status of a referral redemption. Use this endpoint to poll until the status is `completed` or `failed`.
- Documents
  - [Create document](https://developers.akahu.nz/reference/createdocument.md): This endpoint creates a new document record in a `pending` state. Each document represents a single file, which needs to be uploaded shortly after document creation.  If the document file is not…
  - [List documents for application](https://developers.akahu.nz/reference/listdocuments.md)
  - [Get document details](https://developers.akahu.nz/reference/getdocument.md)
  - [Delete document](https://developers.akahu.nz/reference/deletedocument.md)
  - [Download document](https://developers.akahu.nz/reference/downloaddocument.md)
- Datafiles
  - [Create datafile](https://developers.akahu.nz/reference/createdatafile.md): This endpoint creates a new datafile record in a `pending` state. Each datafile represents a single file, which needs to be uploaded shortly after datafile creation.  If the datafile is not uploaded…
  - [List datafiles for application](https://developers.akahu.nz/reference/listdatafiles.md)
  - [Get datafile details](https://developers.akahu.nz/reference/getdatafile.md)
  - [Delete datafile](https://developers.akahu.nz/reference/deletedatafile.md)
  - [Download datafile contents](https://developers.akahu.nz/reference/downloaddatafile.md)
- Reports
  - [Create report](https://developers.akahu.nz/reference/createreport.md): An Akahu Apply report provides an aggregate, enriched view of the data from the application's resources.  The output of a report can be downloaded as an HTML document for human consumption, or as…
  - [Get report details](https://developers.akahu.nz/reference/getreport.md)
  - [Download report HTML](https://developers.akahu.nz/reference/getreporthtmldownload.md)
  - [Download all report data as a single JSON file](https://developers.akahu.nz/reference/getreportjsondownload.md): In order to facilitate fast access to potentially large datasets this endpoint returns a `HTTP 302` redirect to the result. You may need to configure your HTTP client to follow redirects in order to…
  - [Get report data sources](https://developers.akahu.nz/reference/getreportdatasources.md): A data source represents a single financial statement. Note that in the case of multiple statements merged into a single file, there may be multiple data sources pointing to a single document.…
  - [Get report accounts](https://developers.akahu.nz/reference/getreportaccounts.md): **Note**: This endpoint is paginated. To list all Account records, it may be necessary to loop through all available pages using the `cursor` returned with each response.
  - [Get report transactions](https://developers.akahu.nz/reference/getreporttransactions.md): **Note**: This endpoint is paginated. To list all Transaction records, it may be necessary to loop through all available pages using the `cursor` returned with each response.
  - [Get report insights](https://developers.akahu.nz/reference/getreportinsights.md): **Note**: This endpoint is paginated. To list all Insight records, it may be necessary to loop through all available pages using the `cursor` returned with each response.
- Resources
  - [List resources for application](https://developers.akahu.nz/reference/listresources.md): Financial data is added to an Application via one or more Resources. The data from multiple resources is compiled into a single aggregate dataset by generating a Report.
- Sharing Requests
  - [Create sharing request](https://developers.akahu.nz/reference/createsharingrequest.md)
  - [Get a sharing request](https://developers.akahu.nz/reference/getsharingrequest.md)
- Webhooks
  - [test](https://developers.akahu.nz/reference/test.md): A manually triggered test event for a specific endpoint.
  - [application:created](https://developers.akahu.nz/reference/applicationcreated.md): An application was created.
  - [application:archived](https://developers.akahu.nz/reference/applicationarchived.md): An application was archived.
  - [application:unarchived](https://developers.akahu.nz/reference/applicationunarchived.md): An archived application was restored to active.
  - [sharing_request:viewed](https://developers.akahu.nz/reference/sharingrequestviewed.md): An applicant opened a sharing request link.
  - [sharing_request:submitted](https://developers.akahu.nz/reference/sharingrequestsubmitted.md): An applicant submitted data against a sharing request.
  - [document:uploaded](https://developers.akahu.nz/reference/documentuploaded.md): A document was uploaded to an application.
  - [document:completed](https://developers.akahu.nz/reference/documentcompleted.md): A document finished processing successfully.
  - [document:failed](https://developers.akahu.nz/reference/documentfailed.md): A document failed to process.
  - [report:completed](https://developers.akahu.nz/reference/reportcompleted.md): A report finished generating successfully.
  - [report:failed](https://developers.akahu.nz/reference/reportfailed.md): A report failed to generate.
  - [referral:created](https://developers.akahu.nz/reference/referralcreated.md): A referral was created from an application.
  - [referral:revoked](https://developers.akahu.nz/reference/referralrevoked.md): A referral was revoked. Not sent when a referral expires.
  - [referral:redeemed](https://developers.akahu.nz/reference/referralredeemed.md): Another organisation redeemed a referral.
  - [referral_redemption:created](https://developers.akahu.nz/reference/referralredemptioncreated.md): A referral redemption was started.
  - [referral_redemption:completed](https://developers.akahu.nz/reference/referralredemptioncompleted.md): A referral redemption finished and the new application is available.
  - [referral_redemption:failed](https://developers.akahu.nz/reference/referralredemptionfailed.md): A referral redemption failed.

## API Reference: Genie transaction enrichment API
- Transaction Enrichment
  - [Enrich a batch of transactions](https://developers.akahu.nz/reference/geniesearch.md): Enrich a batch of transactions using Genie.
- Merchants
  - [Get merchant](https://developers.akahu.nz/reference/geniegetmerchant.md): Retrieve details for a merchant.
- Outlets
  - [Get outlet](https://developers.akahu.nz/reference/geniegetoutlet.md): Retrieve details for an outlet.
- Categories
  - [Get category](https://developers.akahu.nz/reference/geniegetcategory.md): Retrieve details for a category.
- Webhook keys
  - [Get public key](https://developers.akahu.nz/reference/geniegetpublickey.md): Retrieve a public key for the purpose of validating webhook events.
- Feedback
  - [Submit enrichment feedback](https://developers.akahu.nz/reference/post_feedback.md): Submit feedback about enrichment results returned by Genie.  Using this endpoint you can suggest corrections to an enrichment result or provide information for queries where Genie has not returned a…

## Changelog
- [Transfers API deprecation](https://developers.akahu.nz/changelog/transfers-api-deprecation.md)
- [ASB Transaction Period Increase](https://developers.akahu.nz/changelog/asb-transaction-period-increase.md)
- [Upcoming change to Akahu API response codes](https://developers.akahu.nz/changelog/upcoming-change-to-akahu-api-response-codes.md)
- [Important changes to Personal Apps](https://developers.akahu.nz/changelog/important-changes-to-personal-apps.md)
- [Introducing Wallet Accounts](https://developers.akahu.nz/changelog/normalising-wallet-accounts.md)
- [Exposing Category Data](https://developers.akahu.nz/changelog/exposing-category-data.md)
- [Deprecation of utility Integrations](https://developers.akahu.nz/changelog/deprecation-of-utility-integrations.md)
- [BNZ Enduring Consent Returns](https://developers.akahu.nz/changelog/bnz-enduring-consent-returns.md)
- [Introducing the new payment status_code field](https://developers.akahu.nz/changelog/new-status_code-field-for-payments.md)
- [Introducing the Parties Endpoint for Identity Data (beta)](https://developers.akahu.nz/changelog/introducing-the-parties-api-for-identity-data.md)