---
title: "Get Parties"
method: GET
path: "/parties/{code}"
tags: ["Parties"]
---

# Get Parties

`GET /parties/{code}`

Get identity data related to the registered party at the institution that the user has shared data from. This data is sourced from the profile information at the connected institution rather than any specific account held within.

In general this identity data will relate to the person who has connected the account, however if the user connects an account that is registered under another party (e.g. another person, an LLC, a trust), the result may also contain data pertaining to these other parties. That is to say, Akahu is simply passing this information on from the institution.

> ℹ️
>
> This endpoint returns an array of items for consistency with the parties response from our enduring account connectivity API. However, because each one-off account connection flow relates to only a single session at a single institution, this endpoint will only ever return at-most one party item.

## Path parameters

- `code` string, required

## Headers

- `Content-Type` string

## Response `200`

Successful response.

- object
  - `success` boolean
  - `items` Party[]
    - `name` PartyName — A party's name if available. Your app must have the `IDENTITY_NAMES` scope, otherwise this field will be undefined.
      - `value` string, required — The full name string as provided by the financial institution.
      - `components` PartyNameComponents — A party's name components. All components are optional as format depends on how the data is provided by the bank.
        - `prefix` string — The party's prefix, e.g. Mr
        - `initials` string — The party's initials (Excluding surname), e.g. RJJ for 'Robert John Joseph Smith'
        - `preferred_name` string — The party's preferred name, if they have specified this at their bank e.g. Bob instead of Robert
        - `given_name` string — The party's given name, e.g. Robert
        - `middle_name` string — The party's middle name(s), if any, e.g. John Joseph
        - `surname` string — The party's surname
    - `dob` string — The party's date of birth (yyyy-mm-dd) if available. Your app must have the `IDENTITY_DOBS` scope, otherwise this field will be undefined.
    - `tax_number` string — The party's tax number if available. Your app must have the `IDENTITY_TAX_NUMBERS` scope, otherwise this field will be undefined.
    - `pir` number — The party's Prescribed Investor Rate (PIR) if available. Your app must have the `IDENTITY_TAX_NUMBERS` scope, otherwise this field will be undefined.
    - `email_addresses` PartyEmailAddress[], required — The party's email addresses. Your app must have the `IDENTITY_EMAILS` scope, otherwise an empty array will be returned.
      - `subtype` 'PRIMARY' | 'SECONDARY', required — The email address type. - `PRIMARY` → The party's primary email address. - `SECONDARY` → The party's secondary email address.
      - `value` string, required — The email address string as provided by the financial institution.
      - `verified` boolean, required — Whether the email address has been verified by the financial institution.
    - `phone_numbers` PartyPhoneNumber[], required — The party's phone numbers. Your app must have the `IDENTITY_PHONES` scope, otherwise an empty array will be returned.
      - `subtype` 'MOBILE' | 'HOME' | 'WORK', required — The phone number type. - `MOBILE` → The party's mobile phone number. - `HOME` → The party's home phone number. - `WORK` → The party's work phone number.
      - `value` string, required — The phone number string as provided by the financial institution.
      - `verified` boolean, required — Whether the phone number has been verified by the financial institution.
    - `addresses` PartyAddress[], required — The party's addresses. Your app must have the `IDENTITY_ADDRESSES` scope, otherwise an empty array will be returned.
      - `subtype` 'RESIDENTIAL' | 'POSTAL', required — The address type. - `RESIDENTIAL` → Where the party lives. - `POSTAL` → Where the party receives their postage. (May be the same as the residential address)
      - `value` string, required — The raw address string as provided by the financial institution.
      - `formatted` string — The address having been parsed and formatted uniformly by Akahu
      - `components` object — The parsed address components
        - `street` string — The address's street number and name
        - `suburb` string — The address's suburb
        - `city` string — The address's city
        - `region` string — The address's region
        - `postal_code` string — The address's postal code
        - `country` string — The address's country
      - `google_maps_place_id` string — The Place ID for the address if using the Google Maps APIs

## Other responses

- `400` — Your request was malformed or otherwise unacceptable. More details are provided under the `message` key in the response.
- `401` — You are not authorised to access this content.
- `403` — You are not allowed to access this content.
- `500` — An internal error has prevented us from processing the request. More detail may be supplied in the `message` key.

---

[API](https://skmtc.dev/akahu/apis/akahu-enduring-api.md) · [All operations](https://skmtc.dev/akahu/apis/akahu-enduring-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/akahu/akahu-enduring-api/revisions/b2de9915920d/schema)