OBP Concepts
Core concepts behind the Open Bank Project API.
Core Concepts
The Open Bank Project API is organised around a set of core entities and concepts. Understanding these will help you navigate the API effectively. See also the full API Glossary.
Banks
A Bank is the top-level entity in OBP. Most resources (accounts, customers,
transactions) belong to a bank. Banks are identified by a bank_id string.
GET /obp/v6.0.0/banks
GET /obp/v6.0.0/banks/BANK_IDAccounts
An Account represents a bank account. Accounts belong to a bank and are
identified by a combination of bank_id and account_id. Accounts
have views which control what data is visible.
GET /obp/v6.0.0/my/banks/BANK_ID/accounts
GET /obp/v6.0.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/accountViews
Views control access to account data. Each account can have multiple views
(e.g. owner, public, accountant). Views determine
which fields of a transaction or account are visible to the user. The owner view
provides full access to the account holder. See View endpoints in the API Explorer.
Transactions
A Transaction records a movement of money on an account. Transactions include details like the amount, currency, description, and counterparty. Access to transaction data is controlled by views.
GET /obp/v6.0.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactionsTransaction Requests
A Transaction Request is how you initiate payments in OBP. It goes through a lifecycle of validation, optional challenge, and completion before a Transaction is created. See the Transaction Requests page for details.
Customers
A Customer represents a bank customer (a person or organisation that has a relationship with the bank). A User can be linked to one or more Customers at different banks. Customers hold KYC and CDD information. See Customer endpoints in the API Explorer.
Users
A User is someone who authenticates with the API. Users can have Entitlements (roles) that grant them permissions to perform actions such as creating accounts or managing customers. Users are linked to Customers to access account data.
Consumers (Applications)
A Consumer represents a registered application. When you register your app, you receive a consumer key and secret. These are used during authentication to identify your application to the API. See Consumer Creation.
Entitlements (Roles)
Entitlements grant users permission to call specific API endpoints. Some
entitlements are bank-specific (e.g. CanCreateAccount at a particular bank)
while others are system-wide (e.g. CanGetAnyUser). You can view your
entitlements in My Entitlements. See Role endpoints in the API Explorer.
Consents
Consents allow third-party applications to act on behalf of a user with a limited set of views for a limited time. This supports Open Banking and PSD2 flows where account holders grant access to their data. See the Consents page for details, including Variable Recurring Payments (VRP). See Consent endpoints in the API Explorer.
API Collections
API Collections let you organise and group API endpoints into named collections for easy reference and sharing. You can manage your collections in My API Collections.
Dynamic Entities
Dynamic Entities allow banks and users to define custom data structures at runtime without code changes. These extend the API with bank-specific or user-specific data models (e.g. custom KYC fields, product attributes). See Dynamic Entity endpoints in the API Explorer.
Webhooks
Webhooks allow your application to receive HTTP callbacks when events occur in the banking system (e.g. when a new transaction is created). This enables event-driven architectures. See Webhook endpoints in the API Explorer.