Demo OBP API Sandbox
Welcome! This page is about the OBP API Demo sandbox.
Useful links and minimal instructions:
- The OBP API:
https://demo.openbankproject.com/
- The API Explorer:
https://demo-explorer.openbankproject.com
- Example data on Social Finance (An App to browse the transactions, edit counterparties etc.):
https://demo-sofit.openbankproject.com/
Login with the credentials below or more examples below
username / password : Anil.Uk.07 / X!2deeac4b
- The latest (at 27 Jan 2019) STABLE and DRAFT APIs endpoints are:
https://demo.openbankproject.com/obp/v4.0.0
https://demo.openbankproject.com/obp/v3.1.0
- Questions:
Join our slack channel via this link: https://slack.openbankproject.com/
Now,
A) Register as a developer using 1 above.
B) Build your App! See the Starter SDKs to help you!
C) Login as an Example Bank Customer (see more logins below) so your App has access to customer data. You may need to first logout on 1 above as you may already be logged in as a developer!
The logins above and below are valid for all three services since 2 and 3 above are Apps that authenticate against the API using OAuth just like any other App.
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.
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..
- 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
https://demo.openbankproject.com/obp/v4.0.0
Use the OBP API Explorer to browse and test the API.
Some sandbox data has a public view available, which does not require OAuth to access. For example, here is a list of transactions: https://demo.openbankproject.com/obp/v4.0.0/banks/trn.31.uk.uk/accounts/savings-kids-john/public/transactions
In order to build and test your Apps, you will use two different logins:
-
- Your developer login to get your API keys (see Application registration below)
-
- One or more simulated customer logins to access transaction data etc. (See customer logins below)
Please register your application here. You will get a consumer key and consumer secret for the calls requiring OAuth authentication.
To get started with OBP and OAuth we recommend you use (and fork) one of our Starter SDKs
Note: Make sure you use the correct domain in all calls i.e. for this sandbox use: demo.openbankproject.com !
-
Q: I'm getting a 401 even if I enter the right consumer key and secret. Is the endpoint: rbs... ?
A: No, its demo.openbankproject.com
-
Q: I'm getting 404's / errors
A: Avoid trailing slashes:
https://demo.openbankproject.com/obp/v4.0.0 200 OK
https://demo.openbankproject.com/obp/v4.0.0/ 404 Not Found
https://demo.openbankproject.com/obp/v4.0.0/banks 200 OK
https://demo.openbankproject.com/obp/v4.0.0/banks/ 200 OK {"error":"error"}
https://demo.openbankproject.com/obp/v4.0.0/banks/trn.31.uk.uk 200 OK
https://demo.openbankproject.com/obp/v4.0.0/banks/trn.31.uk.uk/ 404 Not Found
-
Q: I'm getting 404s when POSTing
A: Check you have the correct JSON body, headers and encoding. If in doubt, see an example here
-
Q: Why am I not seeing any data for the test user?
A: Make sure you are using the correct bank_id/account_id for the user. Use the OBP API Explorer to check
-
Q: It still doesn't work. Why?
A: Double check parameters are spelt correctly (including http vs https etc.)
A: Check your encoding (use UTF8)
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. Also you may like to use this tutorial on OAuth
- See the OBP API Explorer to browse and test the API.
Here are some simulated customer logins to test your App / Authentication flow
(use the API Explorer to see which banks each user has accounts at):
"users":[{ "user_name":"Robert.Uk.07", "password":"X!a484fb7d", "email":"robert.uk.07@x.y" },{ "user_name":"Susan.Uk.07", "password":"X!e48fff01", "email":"susan.uk.07@x.y" },{ "user_name":"Anil.Uk.07", "password":"X!2deeac4b", "email":"anil.uk.07@x.y" },{ "user_name":"Ellie.Uk.07", "password":"X!7760c5aa", "email":"ellie.uk.07@x.y" },{ "user_name":"Rosalie.Uk.07", "password":"X!1c9d431e", "email":"rosalie.uk.07@x.y" },{ "user_name":"Chris.Uk.07", "password":"X!702749b6", "email":"chris.uk.07@x.y" },{ "user_name":"Dennis.Uk.07", "password":"X!f85bb709", "email":"dennis.uk.07@x.y" },{ "user_name":"Jane.Uk.07", "password":"X!5328bf30", "email":"jane.uk.07@x.y" },{ "user_name":"Emma.Uk.07", "password":"X!98930297", "email":"emma.uk.07@x.y" },{ "user_name":"Sebastien.Uk.07", "password":"X!a0e71c0e", "email":"sebastien.uk.07@x.y" },{ "user_name":"Wim.Uk.07", "password":"X!2d55c372", "email":"wim.uk.07@x.y" },{ "user_name":"Simon.Uk.07", "password":"X!ef83835f", "email":"simon.uk.07@x.y" },{ "user_name":"Jean-paul.Uk.07", "password":"X!3a14081c", "email":"jean-paul.uk.07@x.y" },{ "user_name":"Elise.Uk.07", "password":"X!11af0a71", "email":"elise.uk.07@x.y" },{ "user_name":"Eleanor.Uk.07", "password":"X!8577cf60", "email":"eleanor.uk.07@x.y" },{ "user_name":"Robert.De.07", "password":"X!ee5a4905", "email":"robert.de.07@x.y" },{ "user_name":"Susan.De.07", "password":"X!56c3e8e7", "email":"susan.de.07@x.y" },{ "user_name":"Anil.De.07", "password":"X!9f9e16cd", "email":"anil.de.07@x.y" },{ "user_name":"Ellie.De.07", "password":"X!00c91b74", "email":"ellie.de.07@x.y" },{ "user_name":"Rosalie.De.07", "password":"X!2aad9349", "email":"rosalie.de.07@x.y" },{ "user_name":"Chris.De.07", "password":"X!6501031f", "email":"chris.de.07@x.y" },{ "user_name":"Dennis.De.07", "password":"X!65837693", "email":"dennis.de.07@x.y" },{ "user_name":"Jane.De.07", "password":"X!7b3bdf34", "email":"jane.de.07@x.y" },{ "user_name":"Emma.De.07", "password":"X!a22a99c3", "email":"emma.de.07@x.y" },{ "user_name":"Sebastien.De.07", "password":"X!f9eba7fc", "email":"sebastien.de.07@x.y" },{ "user_name":"Wim.De.07", "password":"X!95b80791", "email":"wim.de.07@x.y" },{ "user_name":"Simon.De.07", "password":"X!834aa3d5", "email":"simon.de.07@x.y" },{ "user_name":"Jean-paul.De.07", "password":"X!7cabbe48", "email":"jean-paul.de.07@x.y" },{ "user_name":"Elise.De.07", "password":"X!7595f64a", "email":"elise.de.07@x.y" },{ "user_name":"Eleanor.De.07", "password":"X!52273fbd", "email":"eleanor.de.07@x.y" }],
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/passwords).
-
To contact Open Bank Project use:
Email: contact@openbankproject.com
Twitter: @OpenBankProject
Slack: openbankproject.slack.com/ Please email or tweet us for access