View as Markdown

Auth flows

Auth flows describe what a client has to do to grant Aleta access to a custodian — what documents to upload, what consent text to sign, what one-time-code to enter. Different custodians have very different requirements: some accept a digital power of attorney, others insist on a wet-signed PDF, others run their own OAuth-style consent. The auth flow encodes those steps so the onboarding UI can be rendered generically.

Data model

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

  • Name
    id
    Type
    string
    Description

    Stable identifier for the auth flow.

  • Name
    name
    Type
    string
    Description

    Display name shown in the onboarding UI.

Relationships

  • Name
    custodian
    Type
    custodian
    Description

    The custodian this flow grants access to. Embedded in the response — there is no standalone custodian catalogue endpoint.

GET/api/v3/custodian-auth-flows

List auth flows

Returns every onboarding flow available across the catalogue. Filter client-side by the custodian relationship to find the flows that match the custodian a depository was created against.

Request

GET/api/v3/custodian-auth-flows
curl https://platform.aleta.io/api/v3/custodian-auth-flows \
  -H "Authorization: Bearer {access_token}"
GET/api/v3/custodian-auth-flows/{id}

Retrieve a single auth flow

Single-flow lookup. Useful when you have an in-flight authority and want to refresh the description shown to the client.

Request

GET/api/v3/custodian-auth-flows/{id}
curl https://platform.aleta.io/api/v3/custodian-auth-flows/{id} \
  -H "Authorization: Bearer {access_token}"