Featured API Endpoints

This page shows featured APIs collections and frequently used endpoints.

BGv1.3-updatePaymentPsuDataTransactionAuthorisation

OBPv1.2.1-privateAccountsAllBanks

Get Entitlement Requests for the current User

.

GET /obp/v6.0.0/my/entitlement-requests

Get Entitlements for the current User

.

GET /obp/v6.0.0/my/entitlements

UPDATE ATM

Update ATM.

PUT /obp/v6.0.0/banks/BANK_ID/atms/ATM_ID

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 Well Known URIs

Get the OAuth2 server's public Well Known URIs.

GET /obp/v6.0.0/well-known

Get Suggested Session Timeout

Returns information about:

* Suggested session timeout in case of a user inactivity

GET /obp/v6.0.0/ui/suggested-session-timeout

Get User by USERNAME

Get user by PROVIDER and USERNAME

Get a User by their authentication provider and username.

GET /obp/v6.0.0/users/provider/PROVIDER/username/USERNAME

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 Public Accounts at Bank

Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.

GET /obp/v6.0.0/banks/BANK_ID/accounts/public

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

Showing 19 featured endpoints