Welcome to The Open Bank Project API
The Open Bank Project is an open source API and App store for banks that empowers financial institutions to securely and rapidly enhance their digital offerings using an ecosystem of 3rd party applications and services.
Find more information about the project at openbankproject.com.
Get Started
Create an account
First, create a free developer account on this sandbox and request a developer key. You will be asked to submit basic information about your app at this stage. Register here.
Connect your app
Use our SDKs to connect your app to the Open Bank Project APIs. You will need your developer key, which was provided to you when you created an account. See all available APIs on the API Explorer. Please make sure you are using the correct base URL.
Test your app using customer data
Once your app is connected, you can test it using test customer credentials. You can find a list of available customer logins for this sandbox here.
Your APIs
Accounts
Access the user's list of accounts and account information such as the balance. Explore...
Branches, ATMs
Access the list of branches and ATMs for the specified bank including geolocation and opening hours. Explore...
Transactions
Access the transaction history and metadata of accounts. Explore...
Metadata
Enrich transactions and counterparties with metadata including geolocations, comments, pictures and tags (e.g. category of spending). Explore...
Counterparties
Access the payers & payees of an account including metadata such as their aliases, labels, logos and home pages. Explore...
Entitlements
Enable account holders to grant fine-grained access to third-party users and applications. For instance, a business account might provide auditors with full read-only access whilst coworkers might only see the account balance. Explore...
Customer meetings, messages and video conferencing.
Enable customer meetings, messages and video conferencing for KYC and CRM operations (uses third party video streaming). Explore...
Security challenges
Step up authentication using the generic challenge / response mechanism for sensitive operations e.g. to progress a transfer, the user must supply a mobile TAN Explore...
Payments & Transaction requests
Initiate transfers. View and confirm charges (as per PSD2). Explore...
Onboarding & KYC
Perform user, customer and account creation. Access Know Your Customer (KYC) documents, media and KYC status. Explore...
SDK Showcases
Please make sure you are using the correct sandbox domain when using the SDKs. In doubt, drop us a line.
