Featured API Endpoints

Get all users

Get the all Consumers.

Get the logged in user

Returns all available roles

Get the OAuth2 server's public Well Known URIs.

Login is required.

Possible filter on the role field:

eg: /entitlements?role=CanGetCustomersAtOneBank

for the currently authenticated user.

Returns Personal Data Fields (IsPersonal=true) that are managed by the user.

Get all database migration script logs.

This endpoint returns information about all migration scripts that have been executed or attempted.

Get all entitlements that have been granted from a specific group.

This returns all entitlements where the group_id matches the specified GROUP_ID.

Get the bank specified by BANK_ID Returns information about a single bank specified by BANK_ID including:

- bank_id: The unique identifier of this bank - Short and full name of bank - Logo URL - Website

Get all featured API collections with their sort order (admin view).

This endpoint returns the featured collections stored in the database with their sort order. It is intended for administrators to manage the featured list.

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 logs of all levels from the system log cache.

Get all System Dynamic Entities with record counts.

Each dynamic entity in the response includes a record_count field showing how many data records exist for that entity.

This v6.0.0 endpoint returns snake_case field names and an explicit entity_name field.

- 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 API metrics rows. These are records of each REST API call.

require CanReadMetrics role

NOTE: Automatic from_date Default

If you do not provide a from_date parameter, this endpoint will automatically set it to: now - 9 minutes ago

This prevents accidentally querying all metrics since Unix Epoch and ensures reasonable response times. For historical/reporting queries, always explicitly specify your desired from_date.