Akahu Me API

openapi: 3.2.0
info:
  title: Akahu Enduring Me 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: Me
paths:
  /me:
    get:
      tags:
      - Me
      summary: Get current user
      security:
      - user_token: []
      parameters:
      - $ref: '#/components/parameters/xAkahuId'
      description: '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.'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  item:
                    $ref: '#/components/schemas/Me'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '500':
          $ref: '#/components/responses/500'
      operationId: getMe
      x-operation-id-source: derived
components:
  schemas:
    Me:
      type: object
      properties:
        _id:
          type: string
          description: Unique Akahu user identifier.
          example: user_ck9uh3kex000107muemzpdkr7
        access_granted_at:
          type: string
          format: date-time
          description: ISO 8601 formatted date of when the user granted access to the app
          example: '2020-05-05T22:17:08.121Z'
        email:
          type: string
          format: email
          description: Users email
          example: oliver@akahu.nz
  parameters:
    xAkahuId:
      name: X-Akahu-Id
      in: header
      required: true
      description: Your **App ID Token**.
      schema:
        type: string
      example: '{{app_token}}'
  responses:
    '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
  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