View as Markdown

Auth flows

A custodian auth flow defines the onboarding requirements for a specific custodian. Each custodian may have one or more flows.

Data model

JSON:API resource type: custodian-auth-flow.

expectedFilesarray, required

List of files that must be uploaded during onboarding. Each entry contains:

  • name (string, required): Name identifier for the file (e.g. power-of-attorney, consent, back-office-login).
  • description (string, required): Human-readable description of the file.
  • fileType (string, required): Expected file format (e.g. pdf).
supportedConsentTypesarray, required

List of consent types supported by the flow. Possible values: "all", "specific".

Relationships

custodiancustodian

The custodian that this flow belongs to.

GET/api/v3/custodian-auth-flows

List auth flows

List all custodian auth flows. The list also contains outdated flows; creating a custodian authority with an outdated flow returns 400 Bad Request. The response is not paginated.

Request
GET/api/v3/custodian-auth-flows
GET /api/v3/custodian-auth-flows 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": "nordea-20260630",
      "type": "custodian-auth-flow",
      "attributes": {
        "expectedFiles": [
          {
            "name": "power-of-attorney",
            "description": "Signed power of attorney document granting Aleta access to data",
            "fileType": "pdf"
          },
          {
            "name": "consent",
            "description": "Consent between end customer and API user",
            "fileType": "pdf"
          }
        ],
        "supportedConsentTypes": [
          "all",
          "specific"
        ]
      },
      "relationships": {
        "custodian": {
          "data": {
            "type": "custodian",
            "id": "678e9012f3ab456c78d90123"
          }
        }
      }
    },
    {
      "id": "saxo-20260630",
      "type": "custodian-auth-flow",
      "attributes": {
        "expectedFiles": [
          {
            "name": "power-of-attorney",
            "description": "Signed power of attorney document granting Aleta access",
            "fileType": "pdf"
          },
          {
            "name": "consent",
            "description": "Consent between end customer and API user",
            "fileType": "pdf"
          },
          {
            "name": "back-office-login",
            "description": "Back office login information for custodian access",
            "fileType": "pdf"
          }
        ],
        "supportedConsentTypes": [
          "specific"
        ]
      },
      "relationships": {
        "custodian": {
          "data": {
            "type": "custodian",
            "id": "679a2345b6cd789e01f23456"
          }
        }
      }
    }
  ]
}
GET/api/v3/custodian-auth-flows/{id}

Retrieve an auth flow

Get a custodian auth flow by its id.

Parameters

idpath, required

Custodian auth flow identifier.

Errors

  • 404 Not Found — Returned when the custodian auth flow does not exist (detail Custodian Auth Flow '<id>' was not found.).
Request
GET/api/v3/custodian-auth-flows/{id}
GET /api/v3/custodian-auth-flows/nordea-20260630 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": "nordea-20260630",
    "type": "custodian-auth-flow",
    "attributes": {
      "expectedFiles": [
        {
          "name": "power-of-attorney",
          "description": "Signed power of attorney document granting Aleta access to data",
          "fileType": "pdf"
        },
        {
          "name": "consent",
          "description": "Consent between end customer and API user",
          "fileType": "pdf"
        }
      ],
      "supportedConsentTypes": [
        "all",
        "specific"
      ]
    },
    "relationships": {
      "custodian": {
        "data": {
          "type": "custodian",
          "id": "678e9012f3ab456c78d90123"
        }
      }
    }
  }
}