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 API KEY API EXPLORER SOFIT INTRODUCTION

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 sandbox customer logins HERE.

Get your API key

Your APIs

Accounts

Access to accounts (XS2A) and cards. Provide fine-grained access to guests (auditor, accountant or public). Explore..

Branches, ATMs and Products

Access open data related to banks including branches and ATMs including geolocation and opening hours. Explore..

Transactions

Access the transaction history and transaction metadata. 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..

Webhooks

Call external web servies based on Account events. Explore..

Customer onboarding and KYC

Perform user, customer and account creation. Manage Know Your Customer (KYC) documents, media and status. Create customer meetings and messages. Explore..

API Roles, Metrics and Documentation

Control access to endpoints, get API metrics and documentation. Explore..

Payments & Transfers

Initiate Transaction Requests (transfers and payments). View and confirm charges (as per PSD2). Answer strong customer authentication (SCA) challenges. Explore..

Search warehouse

Perform advanced searches and statistics queries on the data warehouse. Explore..

Go to API Explorer

SDK Showcases

Python

By OpenBankProject

Django

By OpenBankProject

NodeJS

By OpenBankProject

React

By OpenBankProject

Next.JS

By OpenBankProject

Flutter

By OpenBankProject

Mac

By OpenBankProject

IOS

By OpenBankProject

Java / Spring Boot

By OpenBankProject

Java / Android

By OpenBankProject

Scala / Liftweb

By OpenBankProject

PHP

By OpenBankProject

C#

By OpenBankProject

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

I got a 404 error, what am I doing wrong

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)

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.

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.
We also support OAuth 2.0. For the technical details of using OBP API with OAuth 2.0, please see here.

Where can I read the API documentation?

Please use the API Explorer

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

Where can i get more information and support?

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

Get started building your applications now!

Get your API key

For technical support

Email us

contact@openbankproject.com

Twitter

@OpenBankProject

Chat

slack.openbankproject.com/

For Banks

API Manager OBP CLI API Tester