v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB

Identity

[Enduring access] Get user identity data

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

Headers

X-Akahu-Idstring required

Your App ID Token.

Response

Successful response.

successboolean

Example response

{
  "success": true,
  "items": [
    {
      "name": {
        "value": "MR ROBERT JOHN JOSEPH SMITH",
        "components": {
          "prefix": "Mr",
          "initials": "RJJ",
          "preferred_name": "Bob",
          "given_name": "Robert",
          "middle_name": "John Joseph",
          "surname": "Smith"
        }
      },
      "email_addresses": [
        {
          "value": "hello@akahu.nz",
          "verified": true
        }
      ],
      "phone_numbers": [
        {
          "value": "+64271234567",
          "verified": true
        }
      ],
      "addresses": [
        {
          "value": "999 QUEEN STREET, AUCKLAND CBD, AUCKLAND, 1010, NEW ZEALAND",
          "formatted": "999 Queen Street, Auckland CBD, Auckland 1010, New Zealand"
        }
      ]
    }
  ]
}