v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB

Accounts

Get account

Get an individual account that the user has connected to your application.

ℹ️

The format for the returned account depends on the permissions you have!

For more details see:

📚 Accessing account data guide
📖 Account model

get/accounts/{id}

Headers

X-Akahu-Idstring required

Your App ID Token.

Response

Successful response.

successboolean

Example response

{
  "item": {
    "_id": "oneoff_acc_1111111111111111111111111",
    "_connection": "conn_cjgaawozb000001nyd111xixr",
    "name": "Demo Account",
    "balance": {
      "current": 99.9,
      "available": 99.9,
      "limit": 1000
    },
    "type": "DEPOSITORY",
    "attributes": [
      "TRANSACTIONS"
    ],
    "formatted_account": "12-1234-1234567-12",
    "meta": {
      "holder": "MR DEMO HOLDER & MS DEMO HOLDER",
      "nickname": "Sam's Savings",
      "product_name": "Super Saver",
      "loan_details": {
        "purpose": "HOME",
        "type": "TABLE",
        "interest": {
          "rate": 4.5,
          "type": "FIXED",
          "expires_at": "2021-01-01T12:00:00.000Z"
        },
        "interest_only_expires_at": "2021-01-01T12:00:00.000Z",
        "term": {
          "years": 30,
          "months": 5
        },
        "matures_at": "2021-01-01T12:00:00.000Z",
        "initial_principal": 100000,
        "repayment": {
          "frequency": "MONTHLY",
          "next_date": "2021-01-01T12:00:00.000Z",
          "next_amount": 1000
        }
      }
    }
  }
}