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 account
item-1

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.

item-2
connect app
test data
item-3

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.

Get your API key

Your APIs

accounts

Accounts

Access the user's list of accounts and account information such as the balance. Explore...

branches

Branches, ATMs

Access the list of branches and ATMs for the specified bank including geolocation and opening hours. Explore...

transactions

Transactions

Access the transaction history and metadata of accounts. Explore...

metadata

Metadata

Enrich transactions and counterparties with metadata including geolocations, comments, pictures and tags (e.g. category of spending). Explore...

counterparties

Counterparties

Access the payers & payees of an account including metadata such as their aliases, labels, logos and home pages. Explore...

entitlements

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...

messages

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

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...

requests

Payments & Transaction requests

Initiate transfers. View and confirm charges (as per PSD2). Explore...

kyc

Onboarding & KYC

Perform user, customer and account creation. Access Know Your Customer (KYC) documents, media and KYC status. Explore...

SDK Showcases

python

Python

By OpenBankProject
django

Django

By OpenBankProject
nodejs

NodeJS

By OpenBankProject
mac

Mac

By OpenBankProject
ios

IOS

By OpenBankProject
android

Android

By OpenBankProject
scala

Scala (liftweb)

By OpenBankProject
php

PHP

By Solonas
csharp

C#

By Sweechem

Please make sure you are using the correct sandbox domain when using the SDKs. In doubt, drop us a line.

Technical FAQs

  • What is the correct base URL for this sandbox?

    The base URL is
    https://api.openbankproject.com
    Please make sure you are using this in all your API calls

  • How should I login?

    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.

  • Where can I read the API documentation?

    Please use the API Explorer

  • Where does the data come from?

    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.

  • I got a 404 error, what am I doing wrong

    1. 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
    2. Double check parameters are spelt correctly (including http vs https etc.)
    3. Check your encoding (use UTF8)

  • How can I use OAuth or Direct Login?

    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

  • How can I use the example customer data?

    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.

  • Where can i get more information and support?

    Please refer to our FAQ, Glossary, join our Slack channels or email us at contact@openbankproject.com

Get started building your application using this sandbox now, register for a developer key

Get your API key