Featured API Endpoints

.

Get the all Consumers.

Get the logged in user

Returns all available roles

Get all the apiCollections for logged in user.

This endpoint gets the Consents created by the current User.

Get all users, optionally filtered.

All query parameters are optional and may be combined.

Get all system-level chat rooms that the current user is a participant of.

Login is required.

Possible filter on the role field:

eg: /entitlements?role=CanGetCustomersAtOneBank

Returns information about:

API version Hosted by information Hosted at information Energy source information * Git Commit

When using ACCOUNT, the payee is set in the request body.

Money goes into the BANK_ID and ACCOUNT_ID specified in the request body.

For sandbox mode, it will use the Cardano Preprod Network. The accountId can be the wallet_id for now, as it uses cardano-wallet in the backend.

Returns the financial Products offered by the bank specified by BANK_ID. Response includes the new tags field.

Optional query parameter tag — filter to products that carry the given tag (case-insensitive). Repeat tag= to require multiple tags (e.g. ?tag=featured&tag=new).

Create Entitlement. Grant Role to User.

Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)

For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""

For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"

Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.

- properties that configure the Web UI behavior and appearance.

Properties with names starting with "webui_" can be stored in the database and managed via API.

Data Sources:

1. Explicit WebUiProps (Database): Custom values created/updated via the API and stored in the database.

2. Implicit WebUiProps (Configuration File): Default values defined in the sample.props.template configuration file.

Get all scanned API versions available in this codebase.

This endpoint returns all API versions that have been discovered/scanned, along with their active status.

Response Fields:

url_prefix: The URL prefix for the version (e.g., "obp", "berlin-group", "open-banking") api_standard: The API standard name (e.g., "OBP", "BG", "UK", "STET") api_short_version: The version number (e.g., "v4.0.0", "v1.3") fully_qualified_version: The fully qualified version combining standard and version (e.g., "OBPv4.0.0", "BGv1.3") is_active: Boolean indicating if the version is currently enabled and accessible

Active Status:

is_active=true: Version is enabled and can be accessed via its URL prefix is_active=false: Version is scanned but disabled (via api_disabled_versions props)

Use Cases:

Discover what API versions are available in the codebase Check which versions are currently enabled Verify that disabled versions configuration is working correctly * API documentation and discovery

Note: This differs from v4.0.0's /api/versions endpoint which shows all scanned versions without is_active status.