## Welcome to the API Sandbox powered by the Open Bank Project!

This sandbox, powered by the Open Bank Project, provides a standard RESTful interface for developers to create customer facing applications for account types. You can use it as a flexible toolbox of data and services to help bring your ideas to life! Use this sandbox to explore the API catalogue, test an example API-powered application, and register for a developer key so you can start building your own applications., test an example API-powered application, and register for a developer key so you can start building your own applications., test an example API-powered application, and register for a developer key so you can start building your own applications.

GET API KEY EXPLORE API MANAGE API UTILITY APP

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

Get your API key

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

Go to API Explorer

# SDK Showcases

## Python

By OpenBankProject

## Django

By OpenBankProject

## NodeJS

By OpenBankProject

## Mac

By OpenBankProject

## IOS

By OpenBankProject

## Android

By OpenBankProject

## Scala (liftweb)

By OpenBankProject

## PHP

By Solonas

## C#

By Sweechem

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

# FAQs

- ## What is the correct base URL for this sandbox?

  The base URL is
  http://apisandbox.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?

  For the current stable API version see 1.4.0.
  For the latest version (recommended) see 2.0.0

- ## How much does it cost?

  It is free to use our sandbox for testing. Using live data may be subject to charges depending on the bank. Contact us to learn more about pricing options.

- ## 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?

  To get started with OBP and OAuth we recommend you use (and fork) one of our OAuth Starter SDKs. Alternatively, for a walkthrough example with sample code, please see here. We use OAuth 1.0a. For deepish technical details of the flow see here
  Note: You don't have to use OAuth for a hackathon - You can use Direct Login instead.

- ## What are some customer logins I can use?

  During the login, the user of your app will be asked for a customer username/password. You can find example login to test your Direct Login or OAuth flow here.

- ## Who owns the IP of the code I create?

  Of course, you do!

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

Get your API key

## Email us

contact@openbankproject.com

## Twitter

@OpenBankProject

## Slack

slack.openbankproject.com