Akahu Data Refresh API

openapi: 3.2.0
info:
  title: Akahu Enduring Data Refresh 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: Data Refresh
paths:
  /refresh:
    post:
      tags:
      - Data Refresh
      summary: Refresh all accounts
      security:
      - user_token: []
      parameters:
      - $ref: '#/components/parameters/xAkahuId'
      description: '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 **asynchronously**, providing clean and consistent data across financial institutions.


        However, there may be certain times that your app requires the most up-to-date account data possible, this endpoint allows you to request a refresh on-demand for these cases.


        For more details see:

        - 📚 Data Refreshes guide'
      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'
        '429':
          description: You have been rate limited on this endpoint.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
              example:
                success: false
                message: Refresh initiated within last 5 minutes
        '500':
          $ref: '#/components/responses/500'
      operationId: postRefresh
      x-operation-id-source: derived
  /refresh/{id}:
    parameters:
    - name: id
      in: path
      required: true
      description: An Akahu Account or Connection ID
      examples:
        account_id:
          summary: Akahu Account ID
          value: acc_1111111111111111111111111
        connection_id:
          summary: Akahu Connection ID
          value: conn_1111111111111111111111111
      schema:
        type: string
    post:
      tags:
      - Data Refresh
      summary: Refresh Individual Accounts or Connections
      security:
      - user_token: []
      parameters:
      - $ref: '#/components/parameters/xAkahuId'
      description: '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 **Connection** ID will request that Akahu performs a data refresh for all of the user''s connected accounts that are held at the financial institution corresponding to that Connection.


        #### Account ID


        Calling this endpoint with an **Account** ID will request that Akahu performs a data refresh for that specific connected account and any other connected accounts that are associated with the same login credentials.


        For example, if the user has shared three ASB accounts from a single set of login credentials and you request a refresh for one, the other two accounts will also be refreshed.


        For more details see:

        - 📚 Data Refreshes guide'
      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'
        '429':
          description: You have been rate limited on this endpoint.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
              example:
                success: false
                message: Refresh initiated within last 5 minutes
        '500':
          $ref: '#/components/responses/500'
      operationId: postRefreshById
      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