Featured API Endpoints

.

.

.

Get the logged in user

Get all the apiCollections for logged in user.

Get the OAuth2 server's public Well Known URIs.

Returns information about:

* Suggested session timeout in case of a user inactivity

Correlated Entities are users and customers linked to the currently authenticated user via User-Customer-Links

Get banks on this API instance Returns a list of banks supported on this server:

- bank_id used as parameter in URLs - Short and full name of bank - Logo URL - Website

Get banks on this API instance Returns a list of banks supported on this server:

- bank_id used as parameter in URLs - Short and full name of bank - Logo URL - Website

Get public accounts at all banks (Anonymous access). Returns accounts that contain at least one public view (a view where is_public is true) For each account the API returns the ID and the available views.

Gets an OIDC/OAuth2 client's metadata by client_id.

Returns client information including name, consumer_id, redirect_uris, and enabled status. This endpoint does not verify the client secret - use POST /oidc/clients/verify for authentication.

These message docs provide example messages sent by OBP to the (RabbitMq) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes. Integrators can use these messages to build Adapters that provide core banking services to OBP.

Note: API Explorer provides a Message Docs page where these messages are displayed. CONNECTOR: rest_vMar2019, stored_procedure_vDec2019 ...

Returns message documentation as JSON Schema format for code generation in any language.

Import bulk data into the sandbox (Authenticated access).

This call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.

The user needs to have CanCreateSandbox entitlement.

Note: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.

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.