Simon Redfern edited this page Oct 31, 2015 · 7 revisions


This is a special page for the Royal Bank of Scotland OBP API sandbox created for the Hack Make the Bank Hackathon in Edinburgh, October 9th - 11th.

Members of the Open Bank Project team are on site. If you have any questions, please ask us!

####Overview Open Bank Project is an open source API for banks providing a common RESTful interface for developers to build customer facing applications. You can use it as a flexible toolbox of data and services to help realise (a.k.a. hack!) your ideas together. For the hackathons, developers have access to simulated transaction data for imaginary customers.

####What sort of applications can I build with the OBP API? Customer facing retail banking and fintech applications for consumers, SMEs, associations, charities, governments and NGOs; including (but not limited to!) Personal Finance Management (PFM) Solutions, online accounting integration, financial widgets, Savings Apps, Education Apps, Gamification, Peace of Mind Apps, Transparency Apps, Crowd funding, on boarding, CRM etc..

####What data and services can I access?

  • Account information, balance and transaction history of multiple bank accounts
  • Enrich bank transactions with metadata (tags, comments, urls and geolocation) for example to link a receipt or video to a transaction
  • Create/Access different views on accounts. Each view grants a subset of the data to a restricted group of users. For example, a customer could offer special views on his account to his accountants, auditors or regulators. A charity might open their accounts to the public
  • Initiate payments
  • Access Customer messages
  • Access data related to branches, ATMs and financial products

####API Endpoint: https://rbs.openbankproject.com/obp/v1.4.0

####API Explorer: Use the OBP API Explorer to browse and test the API.

####This OBP instance contains simulated test accounts for:

####Important Note to Developers: In order to build and test your Apps, you will use two different logins:

    1. Your developer login to get your API keys (see Application registration below)
    1. One or more simulated customer logins to access transaction data etc. (See customer logins below)

####Application registration Please register your application here. You will get a consumer key and consumer secret for the calls requiring OAuth authentication.

####OAuth To get started with OBP and OAuth we recommend you use (and fork) one of our Starter SDKs

Note: Many examples in the docs / SDKs use the general OBP sandbox domain. Make sure you use the correct domain in all calls i.e. rbs.openbankproject.com !


Technical details about the OAuth flow including getting a request token, redirecting the user, getting an access token and accessing protected resources are available here. Please ask us (see below) if you are stuck with this.

####API documentation

####Customer logins

During the OAuth login, the user of your app will be asked for a customer username/password.

Here are some simulated customer logins to test your App / OAuth flow:

Robert, married, retired 63, no mortgage runs a charity has savings.
username : robert.r.c@example.com
password : e9470e20

Susan 39 single mum of two  works a admin job. Rents. 
username : susan.r.c@example.com
password : e00ef2ca

Anil, single 21 has his own business, owns a house, nice car and disposable income.
username : anil.r.c@example.com
password : 40f2a819

Ellie 26, works in retail, married. Husband has good job. Her money is all for luxuries.
username : ellie.r.c@example.com
password : f92b9eb4

To get different logins just for you / your team please ask a member of the Open Bank Project team.

You can use this application which also uses OAuth to browse your transaction data (use the above username/password).

####Questions / Contact?

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.