Welcome to the Open Bank Project API Sandbox
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 for an account .
Connect your app
Use our SDKs to connect your app to the Open Bank Project APIs. You’ll need your developer key, which you should have from when you created your account. Check out all the available APIs on the API Explorer, but make sure that you’re using the correct base URL.
Test your app using customer data
Once your app is connected, you can test it using test customer credentials. View sandbox customer log ons.
Explore APIs
Accounts
Access to accounts (XS2A) and cards. Provide fine-grained access to guests (auditor, accountant or public).
Branches, ATMs and Products
Access open data related to banks including branches and ATMs including geolocation and opening hours.
Transactions
Access the transaction history and transaction metadata.
Metadata
Enrich transactions and counterparties with metadata including geolocations, comments, pictures and tags (e.g. category of spending).
Metadata
Access the payers and payees of an account including metadata such as their aliases, labels, logos and home pages.
Webhooks
Call external web services based on Account events.
Customer onboarding and KYC
Perform user, customer and account creation. Manage Know Your Customer (KYC) documents, media and status. Create customer meetings and messages.
API Roles, Metrics and Documentation
Control access to endpoints, get API metrics and documentation.
SDK Showcases
Please make sure you are using the correct sandbox domain when using the SDKs. In doubt, drop us a line.
FAQs
The base URL is
https://apisandbox.openbankproject.com
Please make sure you are using this in all your API calls
-
Avoid using trailing slashes, else, you would get a 404 error. Example:
.../obp/v1.4.0 200 OK
.../obp/v1.4.0/ 404 Not Found
- Double check parameters are spelt correctly (including http vs https etc.)
- Check your encoding (use UTF8)
There are two ways to authenticate a user:OAuth and Direct Login . If you are using this sandbox for a hackathon, we recommend you use Direct Login to authenticate as it is easier than the OAuth workflow.
If you want to use OBP with OAuth, we recommend you use (and fork) one of our OAuth Starter
SDKs.
If you are using this sandbox for a hackathon, we recommend you use Direct Login.
For an OAuth walkthrough example with sample code, please see here.
We use OAuth 1.0a. For deepish technical details of the flow see
here.
We also support OAuth 2.0. For the technical details of using OBP API with OAuth 2.0, please see
here.
You will need to login to the API as a sandbox customer. You can do this using the API Explorer, or any REST client. You can find some example credentials here.
This depends on the end point and/or OBP instance you are using. A combination of synthetic, anonymised and real data may be available. Please ask support for more information.
Please refer to our FAQ, Glossary, join our chat.openbankproject.com or email us at contact@openbankproject.com
