Getting Started

The Open Bank Project allows you to test APIs directly from the browser, but you can clone and run OBP on your local machine.

Using IntelliJ: https://www.youtube.com/watch?v=oZLg4m3ca4A

First of all, you’ll need to register an account. Head over to the OBP sandbox to sign up and receive your API key.

Complete the form and click Register (You don’t need to check the box about marketing updates to register).

You will receive an email from no-reply@openbankproject.com thanking you for registering, and some useful links to documentation on configuration for OAuth or Direct Login. Click on the link to validate your registration.

Before you can start calling APIs and building your app, you need to have an API key. This can be done after registering by clicking on “Get API Key” from the main menu.

1. Create your OAuth consumer key and secret by completing the form and click submit
2. Redirect URL can be used for OAuth
3. After a user successfully authorizes an app, the authorization server will redirect the user back to the application with either an authorization code or access token

OBP allows you to call APIs directly from the API Explorer.

For all of these examples, we will be hitting the APIs using the API Explorer, but you can find examples using the Postman API Client here.

First, we’re going to get some information about ATMs at a bank by calling getATMs.

Now that you’ve successfully obtained your API key, let’s talk about roles and entitlements.

To call some APIs, you need specific permissions. The OBP sandbox uses a role-based access control (RBAC) system.

Roles can be assigned to users and have a many-to-many relationship with those users. Those records are called Entitlements. You can use the API explorer to submit entitlement requests, which will then be granted or denied by API Administrators.

We didn’t need any roles to call getATMs because ATM data is considered open data. Now, you’re going to create a bank

Please visit our rocket chat channel for more help with entitlements.

You can use existing dummy banks and accounts or you can create your own.

To kick off quickly, we suggest using our existing dummy accounts:

Each user has a dummy bank account with money. You can log in and start testing account and payment APIs immediately.

But you will want to create your own bank eventually, so let’s do that now.

You can create your own bank in the OBP sandbox to test APIs and apps using the endpoint createBank.

When you create a bank, you will automatically be assigned the Role CanCreateEntitlementAtOneBank. This means you have control over your bank and can assign Roles to other Users.

This also means that you will need to assign yourself roles when using other APIs, but we’ll get into that later.

Navigate to the endpoint createBank.

You will see the request body fields listed on the left, including address, bank code, scheme, bank routings, full name, ID, logo and website.

For this example, we’re going to create a bank called OBP Bank. Fill in the missing parameters and press POST.

If we do it right, we should get the following successful response:

And, with that, you now have your very own Bank for creating accounts, products, APIs, entities, and more!