---
title: "[One-off access] Get identity result"
method: GET
path: "/identity/{id}"
tags: ["Identity"]
---

# [One-off access] Get identity result

`GET /identity/{id}`

> ⚠️
>
> **Authentication**
> This endpoint requires [app-scoped](/reference/api-akahu-io-authentication#app-scoped-endpoints) authentication.

Get the results of an Identity OAuth result using the authorization `code` provided upon redirection to your `redirect_uri` after the user's successful completion of the authorisation flow.

This can be used to verify a user's identity using the data that is held about them by their financial institution.

For more information about our Identity OAuth flow see our:
  - [📚 One-off Identity guide](/docs/oneoff-identity-verification)
  - [📚 Identity verification guide](/docs/identity-verification)
  - [📖 Identity model](/docs/the-oneoff-identity-result-model)

## Response `200`

Successful response.

- object
  - `success` boolean
  - `item` OneOffIdentity — One of Identity [Model](/docs/the-oneoff-identity-result-model)
    - `_id` string, cuid — A unique Akahu identity identifier.
    - `status` 'PROCESSING' | 'COMPLETE' | 'ERROR' — - `PROCESSING` → Identity request is in progress, continue to poll for a final state of `COMPLETE` or `ERROR`. - `COMPLETE` → Final success status reached and identity data has been returned. - `ERROR` → Final error status reached due to a fatal error occurred during processing. For more details about one of identity statuses see: - [📖 Identity Status reference](/docs/the-oneoff-identity-result-model#identity-status)
    - `source` ConnectionInfo — Information about the financial institution where the account is held (eg. ANZ bank).
      - `_id` string, cuid, required — The connected financial institution's unique identifier. This will always be prefixed with `conn_`.
      - `name` string, required — Display name for the connected institution.
      - `logo` string, uri, required — A URL pointing to an image of the institution's logo.
      - `connection_type` 'classic' | 'official', required — The type of integration used to connect to this institution. This will be one of: - `classic` A classic Akahu connection, which uses Akahu's custom built integration to connect to the institution. - `official` An official open banking connection, which uses the institution's official open banking APIs.
    - `accounts` OneOffIdentityAccount[] — Identity information registered on linked accounts
      - `bank` string — Display name of the bank
      - `account_number` string — Unique bank account identifer
      - `holder` string — Names of the owner of the account
      - `has_unlisted_holders` boolean — 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.
    - `identities` Identities[] — List of identity information derived from a user's connected accounts.
      - `name` string — Name of one of the account holders.
      - `formatted_account` string — Bank account number of the account this holder was derived from.
      - `meta` object — Currently reserved for future use to house additional metadata about the user.
    - `addresses` Addresses[] — List of addresses derived from a user's connected accounts.
      - `type` 'RESIDENTIAL' | 'POSTAL' | 'UNKNOWN' — Type of address: - `RESIDENTIAL` → Where the user lives. - `POSTAL` → Where the user can be reached by mail such as a PO-BOX. - `UNKNOWN` → Akahu was unable to determine which of the two types of address this is.
      - `value` string — The raw address value provided by the bank.
      - `formatted_address` string — Optional parsed and formatted address string.
      - `place_id` string — Google Places identifier from [Google Places API](https://developers.google.com/maps/documentation/places/web-service/overview).
      - `components` AddressComponents — Breakdown of the parts that make up this address.
        - `street` string — Street name from the address
        - `suburb` string — Suburb name from the address
        - `city` string — City name from the address
        - `region` string — Region name from the address
        - `postal_code` string — Postal code from the address
        - `country` string — Country from the address

## 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.
- `404` — The item you are trying to access doesn't exist.
- `500` — An internal error has prevented us from processing the request. More detail may be supplied in the `message` key.

---

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