Akahu · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akahu Accounts API

7 actions 7 updates phrasing extends openapi/akahu-accounts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Akahu's API. It is a proposal applied on top of the contract, not a document Akahu publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/accounts'].get
$.paths['/accounts/{id}'].get
$.paths['/accounts/{id}/payment-consents/{consent_id}'].delete
$.paths['/accounts/{id}/verification-token'].get
$.paths['/accounts/{id}/verification-token'].delete
$.paths['/accounts/{code}'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Akahu Accounts API
  version: 1.0.0
extends: openapi/akahu-accounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-18'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List all accounts connected to my app
      effect: read
      questions:
      - Which bank accounts have users connected to my app?
      - Can I see every account connected to my application in one list?
      - What account fields come back when I list connected accounts?
      instructions:
      - text: List all connected accounts using my App ID Token {app_id}.
        slots:
          app_id: header.X-Akahu-Id
      - text: Show every bank account linked to my app, authenticating with App ID {app_id}.
        slots:
          app_id: header.X-Akahu-Id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one connected account
      effect: read
      questions:
      - What are the details of a single account my app has access to?
      - Can I look up one connected account by its ID?
      instructions:
      - text: Get account {id}.
        slots:
          id: path.id
      - text: Show the details of connected account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/accounts/{id}/payment-consents/{consent_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an enduring payment consent
      effect: destructive
      questions:
      - How do I stop a payee from charging an account I connected?
      - Can I revoke one payment consent without disconnecting the account?
      instructions:
      - text: Revoke payment consent {consent_id} on account {id}.
        slots:
          consent_id: path.consent_id
          id: path.id
      - text: Stop account {id} from being charged under consent {consent_id}.
        slots:
          id: path.id
          consent_id: path.consent_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/accounts/{id}/verification-token'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a verification token for an account
      effect: read
      questions:
      - How do I get a verification token so an account can be paid?
      - Can I generate a verification token for a BECS account?
      instructions:
      - text: Get a verification token for account {id}.
        slots:
          id: path.id
      - text: Generate a payee verification token for bank account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/accounts/{id}/verification-token'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke the verification token for an account
      effect: destructive
      questions:
      - Can I revoke access to a single bank account by its verification token?
      - Is this endpoint still deprecated for official bank connections?
      instructions:
      - text: Revoke the verification token for account {id}.
        slots:
          id: path.id
      - text: Disconnect account {id} from my app by revoking its token.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/accounts/{code}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get accounts from a one-off code
      effect: read
      questions:
      - How do I get the accounts a user shared with my app through a one-off code?
      - What's the difference between the one-off and enduring account schemas?
      instructions:
      - text: Get the accounts shared with my app using one-off code {code}.
        slots:
          code: path.code
      - text: Look up the accounts the user sent me via one-off code {code}.
        slots:
          code: path.code
      method: generated
      generated: '2026-11-18'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/akahu-accounts-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.