Akahu Authorisations API

openapi: 3.2.0
info:
  title: Akahu Enduring Authorisations API
  description: This API is the primary way for apps to interact with a user's data.
  version: 1.0.0
servers:
- url: https://api.akahu.io/v1
tags:
- name: Authorisations
paths:
  /authorisations/{id}:
    parameters:
    - name: id
      in: path
      required: true
      description: An Akahu Authorisation ID
      example: authorisation_1111111111111111111111111
      schema:
        type: string
    delete:
      tags:
      - Authorisations
      summary: Revoke access to authorisation
      security:
      - user_token: []
      description: '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 application''s access to one of the user''s consented authorisations. After calling this endpoint, your application will no longer have access to the accounts connected via that authorisation (including their associated data and transactions).


        You can find an authorisation for an account by looking at the `_authorisation` field on each account.


        > ℹ️

        >

        > Users can also update their authorisations via the 📚 authorisation flow. The authorisation flow is the only way that users can add or remove access for individual accounts rather than a whole authorisation.


        For more details see:

        - 📚 Accessing account data guide

        - 📖 Account model'
      parameters:
      - $ref: '#/components/parameters/xAkahuId'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
              example:
                success: true
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      operationId: deleteAuthorisationsById
      x-operation-id-source: derived
components:
  responses:
    '404':
      description: The item you are trying to access doesn't exist.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Not Found
    '500':
      description: An internal error has prevented us from processing the request. More detail may be supplied in the `message` key.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Something went wrong
    '400':
      description: Your request was malformed or otherwise unacceptable. More details are provided under the `message` key in the response.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Invalid Content-Type
    '403':
      description: You are not allowed to access this content.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Forbidden
    '401':
      description: You are not authorised to access this content.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Permission Denied
  parameters:
    xAkahuId:
      name: X-Akahu-Id
      in: header
      required: true
      description: Your **App ID Token**.
      schema:
        type: string
      example: '{{app_token}}'
  securitySchemes:
    user_token:
      type: http
      scheme: bearer
      description: 'User-level Authentication:


        Http Bearer Auth with the token being a consented **User Access Token**.

        > `Bearer {user_token}`


        This will allow you to act on a **user''s** behalf when accessing the API.'
    app_auth:
      type: http
      scheme: basic
      description: 'App-level Authentication:


        HTTP Basic Auth with the username being your **App ID Token** and the password being your **App Secret**.

        > `Basic {app_token}:{app_secret}`


        This will allow you to act as your Akahu **application**, rather than as a specific user.'
x-provenance:
  method: searched
  source: https://developers.akahu.nz/reference
  harvested: '2026-10-26'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.akahu.nz/reference/delete_accounts-id-payment-consents-consent-id.md
  - https://developers.akahu.nz/reference/delete_accounts-id-verification-token.md
  - https://developers.akahu.nz/reference/delete_authorisations-id.md
  - https://developers.akahu.nz/reference/delete_token.md
  - https://developers.akahu.nz/reference/delete_webhooks-id.md
  - https://developers.akahu.nz/reference/get_accounts-id-transactions-pending.md
  - https://developers.akahu.nz/reference/get_accounts-id-transactions.md
  - https://developers.akahu.nz/reference/get_accounts-id-verification-token.md
  - https://developers.akahu.nz/reference/get_accounts-id.md
  - https://developers.akahu.nz/reference/get_accounts.md
  - https://developers.akahu.nz/reference/get_categories-id.md
  - https://developers.akahu.nz/reference/get_categories.md
  - https://developers.akahu.nz/reference/get_connections-id.md
  - https://developers.akahu.nz/reference/get_connections.md
  - https://developers.akahu.nz/reference/get_identity-id.md
  - https://developers.akahu.nz/reference/get_keys-id.md
  - https://developers.akahu.nz/reference/get_me.md
  - https://developers.akahu.nz/reference/get_parties.md
  - https://developers.akahu.nz/reference/get_payments-id.md
  - https://developers.akahu.nz/reference/get_payments.md
  - https://developers.akahu.nz/reference/get_transactions-id.md
  - https://developers.akahu.nz/reference/get_transactions-pending.md
  - https://developers.akahu.nz/reference/get_transactions.md
  - https://developers.akahu.nz/reference/get_webhook-events.md
  - https://developers.akahu.nz/reference/get_webhooks.md
  - https://developers.akahu.nz/reference/post_identity-id-verify-name.md
  - https://developers.akahu.nz/reference/post_par.md
  - https://developers.akahu.nz/reference/post_payments-ird.md
  - https://developers.akahu.nz/reference/post_payments.md
  - https://developers.akahu.nz/reference/post_refresh-id.md
  - https://developers.akahu.nz/reference/post_refresh.md
  - https://developers.akahu.nz/reference/post_support-transaction-id.md
  - https://developers.akahu.nz/reference/post_token.md
  - https://developers.akahu.nz/reference/post_transactions-ids.md
  - https://developers.akahu.nz/reference/post_verify-name-id.md
  - https://developers.akahu.nz/reference/post_verify-name.md
  - https://developers.akahu.nz/reference/post_webhooks.md
  merge:
    pages: 37
    deduped: 269
    conflicts_kept_first: 0