Akahu · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akahu Identity API

7 actions 7 updates phrasing extends openapi/akahu-identity-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['/identity/{id}'].get
$.paths['/identity/{id}/verify/name'].post
$.paths['/parties'].get
$.paths['/verify/name'].post
$.paths['/verify/name/{id}'].post
$.paths['/identity/{code}/verify/name'].post

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 Identity API
  version: 1.0.0
extends: openapi/akahu-identity-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['/identity/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-off identity result
      effect: read
      questions:
      - How do I get the identity data from an authorization code after a user finishes the one-off identity flow?
      - What does the one-off identity result contain?
      instructions:
      - text: Get the one-off identity result for authorization code {id}.
        slots:
          id: path.id
      - text: Look up the identity data returned from the one-off OAuth redirect with code {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/identity/{id}/verify/name'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a name from a one-off identity result
      effect: read
      questions:
      - How do I check that the name on file matches the one returned from a one-off identity result?
      - Can I verify a user's given and family name against the one-off identity data?
      instructions:
      - text: Verify the name {given_name} {family_name} against the one-off identity result {id}.
        slots:
          given_name: requestBody.given_name
          family_name: requestBody.family_name
          id: path.id
      - text: Check the middle name {middle_name} and initials {initials} against one-off identity {id}.
        slots:
          middle_name: requestBody.middle_name
          initials: requestBody.initials
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/parties'].get
  update:
    x-apievangelist-phrasing:
      intent: List parties who connected accounts
      effect: read
      questions:
      - Which parties have authorised financial account connections with my app?
      - Can I see the party-level identity data for all connected users?
      instructions:
      - text: List the parties who connected accounts to my app.
      - text: Show the account connection parties for app {X-Akahu-Id}.
        slots:
          X-Akahu-Id: header.X-Akahu-Id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/verify/name'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a name across all connected accounts
      effect: read
      questions:
      - Can I verify a user's name against every account they have connected to my app?
      - How do I match the name on file against all connected account holder names?
      instructions:
      - text: Verify the name {given_name} {family_name} against all accounts connected by the user.
        slots:
          given_name: requestBody.given_name
          family_name: requestBody.family_name
      - text: Check the user's initials {initials} against every connected account.
        slots:
          initials: requestBody.initials
      method: generated
      generated: '2026-11-18'
- target: $.paths['/verify/name/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a name against one account
      effect: read
      questions:
      - Can I verify a user's name against just one specific account?
      - How do I confirm the name on file matches the holder of a single connected account?
      instructions:
      - text: Verify the name {given_name} {family_name} against account {id}.
        slots:
          given_name: requestBody.given_name
          family_name: requestBody.family_name
          id: path.id
      - text: Check the user's middle name {middle_name} against account {id}.
        slots:
          middle_name: requestBody.middle_name
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/identity/{code}/verify/name'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a name from a one-off identity code
      effect: read
      questions:
      - How do I verify a user's name using the one-off authorization code?
      - Can I match a given name against the one-off identity result code?
      instructions:
      - text: Verify the name {given_name} {family_name} from one-off identity code {code}.
        slots:
          given_name: requestBody.given_name
          family_name: requestBody.family_name
          code: path.code
      - text: Check the user's initials {initials} against one-off identity code {code}.
        slots:
          initials: requestBody.initials
          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-identity-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.