Featured API Endpoints

This page shows featured APIs collections and frequently used endpoints.

BGv1.3-updatePaymentPsuDataTransactionAuthorisation

OBPv4.0.0-getMyPersonalUserAttributes

Get Entitlements for the current User

.

GET /obp/v6.0.0/my/entitlements

Get User (Current)

Get the logged in user

GET /obp/v6.0.0/users/current

Get My Api Collections

Get all the apiCollections for logged in user.

GET /obp/v6.0.0/my/api-collections

Get Glossary of the API

Get API Glossary

Returns the glossary of the API

GET /obp/v6.0.0/api/glossary

Get My Api Collection Endpoints

Get Api Collection Endpoints By API_COLLECTION_NAME.

GET /obp/v6.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints

Get Well Known URIs

Get the OAuth2 server's public Well Known URIs.

GET /obp/v6.0.0/well-known

Create Dynamic Resource Doc

Create a Dynamic Resource Doc.

The connector_method_body is URL-encoded format String

POST /obp/v6.0.0/management/dynamic-resource-docs

Get Correlated Entities for the current User

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

GET /obp/v6.0.0/my/correlated-entities

Get API Info (root)

Returns information about:

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

GET /obp/v6.0.0/root

Get Banks

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 /obp/v6.0.0/banks
BankAccount Information Service (AIS)PSD2

Get Banks

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 /obp/v6.0.0/banks
BankAccount Information Service (AIS)PSD2

Get Public Accounts at all Banks

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.

GET /obp/v6.0.0/accounts/public

Get OIDC Client

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.

GET /obp/v6.0.0/oidc/clients/CLIENT_ID

Create sandbox

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.

POST /obp/v6.0.0/sandbox/data-import

Showing 19 featured endpoints