Get Parties

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.

Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!