Custodians

Custodians are the banks and brokers on the other end of every data feed. The v1 catalogue endpoint exists so integrations can render a custodian picker or resolve the custodian a feed belongs to without hard-coding identifiers.

Data model

idstring: Stable identifier for the custodian. A UUID — treat it as opaque.
identifierstring or null: Machine-readable slug, e.g. own-investments-dk. Stable across environments — safer than id for configuration files.
namestring: Display name shown in the product.
group_namestring or null: The banking group the custodian belongs to, when it is part of one.
base_currency_codestring or null: ISO 4217 code of the custodian's base currency.

GET/v1/custodians

List custodians

Returns the catalogue in name order, one page at a time: the banks Aleta supports, plus every bank the tenant holds a custody account at (whoever can see that account), so a custody account always names a listed bank and every user of the tenant sees the same catalogue. Customer-specific entries, placeholders and duplicates from the legacy platform are not listed. GET /v1/custodians/{custodian_id} answers a listed bank, else 404. Pass limit (default 100, at most 1000) and the next_cursor of the previous page as cursor; next_cursor is null on the last page. Fetch once, cache, and match on identifier client-side. An unknown query parameter is a 400.

Optional attributes

limitinteger: Page size. Default 100; a value below 1 or above 1000 is clamped to that range.
cursorstring: The next_cursor of the previous page.

Request

GET/v1/custodians

curl https://api.aleta.ai/v1/custodians \
  -H "Authorization: Bearer {access_token}"

Response

{
  "data": [
    {
      "id": "019dff7d-5a85-741e-8437-22e1d5f7c685",
      "identifier": "own-investments-dk",
      "name": "Own Investments",
      "group_name": null,
      "base_currency_code": "DKK"
    }
  ],
  "next_cursor": null,
  "limit": 100
}

GET/v1/custodians/{custodian_id}

Get a custodian

Returns one listed bank, in the shape of the list's entries. A bank that is not listed, an unknown id and an id that is not a UUID are 404.