Akahu · Schema

CreateReferralRedemptionParams

CompanyFinanceOpen BankingNew Zealand

Properties

Name Type Description
code object
reference string Optional reference to use for the application created in the redeeming organisation. Defaults to the referral reference.
report_type string If `report_type` is omitted, the application uses your organisation's default report type.
View JSON Schema on GitHub

JSON Schema

akahu-create-referral-redemption-params-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akahu/main/json-schema/akahu-create-referral-redemption-params-schema.json",
  "title": "CreateReferralRedemptionParams",
  "x-generated": "2026-10-26",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/akahu-referrals-api-openapi.yml#/components/schemas/CreateReferralRedemptionParams",
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/$defs/ReferralCode"
    },
    "reference": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500,
      "description": "Optional reference to use for the application created in the redeeming organisation. Defaults to the referral reference."
    },
    "report_type": {
      "type": "string",
      "enum": [
        "standard",
        "income"
      ],
      "description": "If `report_type` is omitted, the application uses your organisation's default report type."
    }
  },
  "required": [
    "code"
  ],
  "$defs": {
    "ReferralCode": {
      "type": "string",
      "pattern": "^AK_[A-Z0-9]{10}$",
      "description": "A referral code using the format `AK_` followed by 10 uppercase alphanumeric characters."
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/akahu-create-referral-redemption-params"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.