Custodians

Custodian integration endpoints allow you to manage the process of granting Aleta access to pull data from custodians (banks) on behalf of legal entities.

The process involves three resource types:

Custodian — A supported custodian.
Custodian Auth Flow — A template that defines the onboarding requirements for a specific custodian (required files, supported consent types).
Custodian Authority — A lifecycle object representing the authority granted to Aleta to access data at a custodian for a given legal entity.

Data model

JSON:API resource type: custodian.

identifierstring or null: Unique identifier for the custodian (e.g. nordea-dk). null when the custodian has none.
namestring, required: Display name of the custodian.
countrystring or null: Country code of the custodian. null when no country is recorded.

GET/api/v3/custodians

List custodians

List all custodians available through the API. The response is not paginated.

Request

GET/api/v3/custodians

GET /api/v3/custodians HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <access token>
Host: api.aleta.ai

Response (200 OK)

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "678e9012f3ab456c78d90123",
      "type": "custodian",
      "attributes": {
        "identifier": "nordea-dk",
        "name": "Nordea Bank",
        "country": "DK"
      }
    },
    {
      "id": "678f0123a4bc567d89e01234",
      "type": "custodian",
      "attributes": {
        "identifier": "danske-bank-dk",
        "name": "Danske Bank",
        "country": "DK"
      }
    },
    {
      "id": "679a2345b6cd789e01f23456",
      "type": "custodian",
      "attributes": {
        "identifier": "saxo-dk",
        "name": "Saxo Bank",
        "country": "DK"
      }
    }
  ]
}