Skip to content

INV OBP API Sandbox

Jump to bottom Edit New page
Ismail CHAIB edited this page May 3, 2018 · 5 revisions

Hello!

Welcome. This page is about the INV OBP API sandbox.

INV Fintech, the global fintech accelerator, and the Open Bank Project, the leading open API solution for banks, have teamed up to release an Industry Sandbox for the US.

This sandbox offers a shared and controlled development environment to bring fintech ideas to life. Approved fintech solution providers can access data and services from participating banks to build and showcase their innovative solutions. Powered by Open Bank Project technology, the sandbox contains test data which emulates real transactions and offers access to over 160 standard banking APIs for transactions, payment initiation, KYC checks, and much more.

The sandbox is available to startups selected to join INV’s upcoming cohort and to the twelve financial institution partners supporting the program. Each startup will be able to demonstrate its solution in a simulated bank environment without the difficulties associated with integrating with a real bank infrastructure.

Short link to this page: http://bit.ly/obp-inv

TL;DR

Useful links and minimal instructions:

  1. The OBP API - where you need to register first

https://apisandbox.openbankproject.com/

  1. The API Explorer - where you can see all available APIs

https://apiexplorersandbox.openbankproject.com

  1. *Example data * to test your application

Login with the credentials below or more examples below

   "user_name":"Robert.Us.01",
   "password":"X!39670561"
  1. Questions: if you have any questions or need support, Join our slack channel via this link: http://bit.ly/obpslack1

Now,

A) Register as a developer using on https://apisandbox.openbankproject.com/

B) Build your App! See the Starter SDKs to help you!

C) Login as an INV 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.

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

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: Make sure you use the correct domain in all calls i.e. for this sandbox use: apisandbox.openbankproject.com !

FAQ:

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

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 (use the API Explorer to see which banks they relate to):

    {
        "user_name":"Robert.Us.01",
        "password":"X!39670561",
        "email":"robert.us.01@x.y"
      },{
        "user_name":"Susan.Us.01",
        "password":"X!ba645904",
        "email":"susan.us.01@x.y"
      },{
        "user_name":"Anil.Us.01",
        "password":"X!5ffe4dea",
        "email":"anil.us.01@x.y"
      },{
        "user_name":"Ellie.Us.01",
        "password":"X!df12720c",
        "email":"ellie.us.01@x.y"
      },{
        "user_name":"Rosalie.Us.01",
        "password":"X!df05a6b9",
        "email":"rosalie.us.01@x.y"
      },{
        "user_name":"Chris.Us.01",
        "password":"X!f55b78d5",
        "email":"chris.us.01@x.y"
      },{
        "user_name":"Dennis.Us.01",
        "password":"X!8251c34b",
        "email":"dennis.us.01@x.y"
      },{
        "user_name":"Jane.Us.01",
        "password":"X!d62206f7",
        "email":"jane.us.01@x.y"
      },{
        "user_name":"Emma.Us.01",
        "password":"X!f40ef1b4",
        "email":"emma.us.01@x.y"
      },{
        "user_name":"Sebastien.Us.01",
        "password":"X!3c3846fe",
        "email":"sebastien.us.01@x.y"
      },{
        "user_name":"Wim.Us.01",
        "password":"X!8d18b93b",
        "email":"wim.us.01@x.y"
      },{
        "user_name":"Simon.Us.01",
        "password":"X!113c5732",
        "email":"simon.us.01@x.y"
      },{
        "user_name":"Jean-paul.Us.01",
        "password":"X!097b6a9a",
        "email":"jean-paul.us.01@x.y"
      },{
        "user_name":"Elise.Us.01",
        "password":"X!dbdfc939",
        "email":"elise.us.01@x.y"
      },{
        "user_name":"Eleanor.Us.01",
        "password":"X!3abbc8c2",
        "email":"eleanor.us.01@x.y"
      }
        "user_name":"Susan.Uk.01",
        "password":"X!a1bd94d9",
        "email":"susan.uk.01@x.y"
      },{
        "user_name":"Anil.Uk.01",
        "password":"X!5ca8537e",
        "email":"anil.uk.01@x.y"
      },{
        "user_name":"Ellie.Uk.01",
        "password":"X!9c761218",
        "email":"ellie.uk.01@x.y"
      },{
        "user_name":"Rosalie.Uk.01",
        "password":"X!17cd72ac",
        "email":"rosalie.uk.01@x.y"
      },{
        "user_name":"Chris.Uk.01",
        "password":"X!f0ccaafa",
        "email":"chris.uk.01@x.y"
      },{
        "user_name":"Dennis.Uk.01",
        "password":"X!dd43a5b7",
        "email":"dennis.uk.01@x.y"
      },{
        "user_name":"Jane.Uk.01",
        "password":"X!2b34edf3",
        "email":"jane.uk.01@x.y"
      },{
        "user_name":"Emma.Uk.01",
        "password":"X!e5e4adf6",
        "email":"emma.uk.01@x.y"
      },{
        "user_name":"Sebastien.Uk.01",
        "password":"X!7af4cefa",
        "email":"sebastien.uk.01@x.y"
      },{
        "user_name":"Wim.Uk.01",
        "password":"X!6d580c69",
        "email":"wim.uk.01@x.y"
      },{
        "user_name":"Simon.Uk.01",
        "password":"X!40a9ba1e",
        "email":"simon.uk.01@x.y"
      },{
        "user_name":"Jean-paul.Uk.01",
        "password":"X!8b46e410",
        "email":"jean-paul.uk.01@x.y"
      },{
        "user_name":"Elise.Uk.01",
        "password":"X!e1d1f443",
        "email":"elise.uk.01@x.y"
      },{
        "user_name":"Eleanor.Uk.01",
        "password":"X!da77ee0b",
        "email":"eleanor.uk.01@x.y"
      }

NOTE

It works with almost all markdown flavours (the below blank line matters).

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

Questions / Contact?

Add a custom footer
Add a custom sidebar
Clone this wiki locally