Account_2

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akahu/main/json-schema/akahu-account-2-schema.json",
  "title": "Account_2",
  "x-generated": "2026-10-26",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/akahu-accounts-api-openapi.yml#/components/schemas/Account_2",
  "type": "object",
  "required": [
    "_id",
    "_connection",
    "name",
    "formatted_account",
    "type",
    "attributes",
    "balance",
    "meta"
  ],
  "properties": {
    "_id": {
      "type": "string",
      "description": "A unique identifier for the account in the Akahu system. It is always be prefixed by `oneoff_acc_` so that you can tell that it belongs to an account."
    },
    "_connection": {
      "type": "string",
      "description": "Connection ID identifying the institution the account has been connected from."
    },
    "name": {
      "type": "string",
      "description": "The name of this account. If the connection allows customisation, the name will be the custom name (or nickname), eg. \"Spending Account\". Otherwise Akahu falls back to the product name, eg. \"Super Saver\"."
    },
    "balance": {
      "type": "object",
      "description": "The account balance",
      "required": [
        "current"
      ],
      "properties": {
        "current": {
          "type": "number",
          "description": "The current account balance."
        },
        "available": {
          "type": "number",
          "description": "The balance that is currently available to the account holder."
        },
        "limit": {
          "type": "number",
          "description": "The credit limit for this account. For example a credit card limit or an overdraft limit. This value is only present when provided directly by the connected financial institution."
        }
      }
    },
    "type": {
      "type": "string",
      "enum": [
        "DEPOSITORY",
        "CREDIT CARD",
        "LOAN"
      ],
      "description": "The account type.\n\n- `DEPOSITORY` → A regular transactional or savings bank account.\n- `CREDIT CARD` → A credit card.\n- `LOAN` → A loan account (includes line-of-credit accounts such as revolving home loans).\n\n> ℹ️ Note that currently only the listed account types are supported for retrieval via the Akahu one-off API. Additional account types (such as investment and Kiwisaver accounts) may be added at a later date."
    },
    "attributes": {
      "type": "array",
      "description": "Indicates what functionality the account has.\n- `TRANSACTIONS` → This account can provide transaction data.\n- `TRANSACTION_EXPORTS` → This account can provide transaction data in PDF format.\n- `STATEMENTS` → This account can provide official PDF statements.",
      "items": {
        "type": "string",
        "enum": [
          "TRANSACTIONS",
          "TRANSACTION_EXPORTS",
          "STATEMENTS"
        ]
      }
    },
    "formatted_account": {
      "type": "string",
      "description": "For bank accounts, this will contain the account number in the standardised format `00-0000-0000000-00`. For non bank accounts (credit cards and some loans), the account number format provided by the bank will be passed through."
    },
    "meta": {
      "type": "object",
      "description": "Metadata regarding this account",
      "properties": {
        "holder": {
          "type": "string",
          "description": "The account holder name as provided by the bank"
        },
        "has_unlisted_holders": {
          "type": "boolean",
          "description": "Indicates if the account has other holders that are not listed in the holder field. This only applies to official open banking connections where the institution indicates a joint account, but only provides the authorising party's name."
        },
        "nickname": {
          "type": "string",
          "description": "The account nickname"
        },
        "product_name": {
          "type": "string",
          "description": "The account product name as provided by the bank"
        },
        "loan_details": {
          "type": "object",
          "description": "Details about a loan account, if available.",
          "properties": {
            "purpose": {
              "type": "string",
              "description": "The purpose of the loan, if we can't determine the purpose, this will be `UNKNOWN`",
              "enum": [
                "HOME",
                "PERSONAL",
                "BUSINESS",
                "UNKNOWN"
              ]
            },
            "type": {
              "type": "string",
              "description": "The type of loan, if we can't determine the type, this will be `UNKNOWN`",
              "enum": [
                "TABLE",
                "REDUCING",
                "REVOLVING",
                "UNKNOWN"
              ]
            },
            "interest": {
              "type": "object",
              "description": "Interest rate information for the loan.",
              "properties": {
                "rate": {
                  "type": "number",
                  "description": "The interest rate on the loan."
                },
                "type": {
                  "type": "string",
                  "description": "The type of interest rate.",
                  "enum": [
                    "FIXED",
                    "FLOATING"
                  ]
                },
                "expires_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "When this interest rate expires, if available."
                }
              },
              "required": [
                "rate",
                "type"
              ]
            },
            "is_interest_only": {
              "type": "boolean",
              "description": "Is the loan currently in an interest only period?"
            },
            "interest_only_expires_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the interest only period expires, if available."
            },
            "term": {
              "type": "object",
              "description": "The duration/term of the loan for it to be paid to completion from the start date of the loan.",
              "properties": {
                "years": {
                  "type": "number",
                  "description": "The number of years the loan is for."
                },
                "months": {
                  "type": "number",
                  "description": "The number of months the loan is for."
                }
              }
            },
            "matures_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the loan matures, if available."
            },
            "initial_principal": {
              "type": "number",
              "description": "The loan initial principal amount, this was the original amount borrowed."
            },
            "repayment": {
              "type": "object",
              "description": "Loan repayment information if available.",
              "properties": {
                "frequency": {
                  "type": "string",
                  "description": "The frequency of the loan repayment.",
                  "enum": [
                    "WEEKLY",
                    "FORTNIGHTLY",
                    "MONTHLY",
                    "QUARTERLY",
                    "BIANNUALLY",
                    "ANNUALLY"
                  ]
                },
                "next_date": {
                  "type": "string",
                  "format": "date-time",
                  "description": "The next repayment date, if available."
                },
                "next_amount": {
                  "type": "number",
                  "description": "The next instalment amount."
                }
              },
              "required": [
                "next_amount"
              ]
            }
          },
          "required": [
            "purpose",
            "type",
            "interest",
            "is_interest_only"
          ]
        }
      }
    }
  }
}