Identity

[Enduring access] Get user identity data

Changed on Nov 3, 2026

Get a list of the parties who have authorised financial account connections with your app. This data is sourced from the customer profile information held by the financial institution rather than any specific account held within.

⚠️

This data relates to the party that authorised the account connection as reported by the financial institution. Due to some quirks with the data held in bank systems, it is possible in rare cases that company details are returned instead of an individual person's. This can happen for small business bank accounts where a single shared login is set up for the company (rather than a proper company setup where staff have separate logins).

get/parties

Request

Base URL
https://api.akahu.io/v1
URL
https://api.akahu.io/v1/parties
Auth
HTTP bearer

Headers

X-Akahu-Idstring required

Your App ID Token.

Response

Successful response.

successboolean

Example response

{
  "success": true,
  "items": [
    {
      "_authorisation": "authorisation_1111111111111111111111111",
      "name": {
        "value": "Mr Frodo Baggins"
      },
      "dob": {
        "value": "2001-12-20"
      },
      "tax_number": {
        "value": "123-456-789"
      },
      "phone_numbers": [
        {
          "value": "+642101234567"
        }
      ],
      "email_addresses": [
        {
          "value": "frodo.baggins@aol.com"
        }
      ],
      "addresses": [
        {
          "subtype": "RESIDENTIAL",
          "components": {
            "street": "27 Bag End",
            "suburb": "Bagshot Row",
            "city": "Hobbiton",
            "region": "Hobbiton",
            "country": "Middle Earth"
          }
        }
      ]
    }
  ]
}

Changes

Nov 3, 202652ef70f3df76 Revision changes
- breaking
  the response property // became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the // response's property type changed from string to object for status
- breaking
  the // response's property type changed from string to object for status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  added the new UNKNOWN enum value to the //// response property for the response status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  removed the SECONDARY enum value from the //// response property for the response status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status

Operation history