v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB

Identity

[One-off access] Get identity result

⚠️

Authentication This endpoint requires app-scoped 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
📚 Identity verification guide
📖 Identity model

get/identity/{id}

Response

Successful response.

successboolean

Example response

{
  "item": {
    "_id": "id_c01234567890123456789012345",
    "status": "PROCESSING",
    "source": {
      "_id": "conn_cjgaac5at000001qi2yw8ftil",
      "name": "My Bank",
      "logo": "https://cdn.akahu.nz/logos/connections/conn_cjgaac5at000001qi2yw8ftil",
      "connection_type": "official"
    },
    "accounts": [
      {
        "bank": "Kiwibank",
        "account_number": "38-9009-0000000-00",
        "holder": "F BAGGINS"
      }
    ],
    "identities": [
      {
        "name": "F BAGGINS",
        "formatted_account": "38-9009-0000000-00",
        "meta": {}
      }
    ],
    "addresses": [
      {
        "type": "RESIDENTIAL",
        "value": "27 Bag End, Bagshot Row, Hobbiton, 1011",
        "formatted_address": "27 Bag End, Bagshot Row, Hobbiton, Middle Earth, 1011",
        "place_id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
        "components": {
          "street": "27 Bag End",
          "suburb": "Bagshot Row",
          "city": "Hobbiton",
          "region": "Hobbiton",
          "country": "Middle Earth"
        }
      }
    ]
  }
}