BNP Paribas OBP API Sandbox

Mulugeta Ayalew edited this page Jun 9, 2017 · 82 revisions

Hello!

This is a special page for the BNP Paribas OBP API sandbox created for the BNP Paribas International Hackathon on June 09-11 2017 in Berlin, Brussels, Istanbul, Luxemburg, Nanjing, Paris, Rome, San Francisco, Singapore and Warsaw.

Status

This document may be updated.

Overview

Open Bank Project is an open source API for banks that provides a RESTful interface for developers to build customer facing applications without needing to code for each bank and/or account type differently. You can use it as a flexible toolbox of data and services to help realise (a.k.a. hack!) your ideas together. For these hackathons, developers have access to simulated transaction data for imaginary customers and anonymised data which requires explicit permision to access (see below).

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, Data Analytics etc..

What data and services can I access?

This OBP instance contains a mixture of dummy customer related data (see the list below) and anonymised BNP Paribas warehouse data.

Dummy Customer related data / services include:

  • 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 (Transaction Requests)
  • Onboard Customers (KYC etc.)

Anonymised Data Warehouse data:

Please note: Access to the Anonymised Data Warehouse is restricted to the participants of the Internatational Hackathon

  1. Logout here https://bnpparibas-api.openbankproject.com/

  2. Register a username / password that will be used in your App to get access to the anonymised datawarehouse data.

  3. Login here as that user https://bnpparibas-apiexplorer.openbankproject.com/

  4. Get the user_id of this user using the API / API Explorer https://bnpparibas-apiexplorer.openbankproject.com/?version=2.0.0&ignoredefcat=true#2_0_0-getCurrentUser

  5. Send us your Full Name, Project Name, email and the user_id(s) that should access this data to bnpp@tesobe.com or via Slack.

  6. Once we have granted you access we will notifiy you on Slack

  7. Now you can use the end point documented at Search Warehouse

Available indices in the warehouse:

  • 20170531-declared-products, 20170531-sme-transactions, 20170531-transactions, 20170531-contracts, 20170531-taxes, 20170531-charges, 20170531-revenues, 20170531-individual-clients, 20170531-markets, 20170531-sme-client, 20170531-assets, 20170531-sme-contracts

Search Warehouse examples

Individuals

  • Get all customers' transactions: https://bnpparibas-api.openbankproject.com/obp/v2.0.0/search/warehouse/q=_index:20170531-transactions

  • To page through all transactions use size=x and from=y (Hint: hits.total in the response tells you the limit for subsequent calls): https://bnpparibas-api.openbankproject.com/obp/v2.0.0/search/warehouse/q=_index:20170531-transactions&size=10&from=34

  • Get transactions for one particular customer: Urlencode the query: https://bnpparibas-api.openbankproject.com/obp/v2.0.0/search/warehouse/q=_index:20170531-transactions+AND+customer_id:139468

  • Get all last year transactions of one customer: See above, then filter transaction_date for regex /^16\// in your application.

  • Get Saving Capacity of one customer: Check field mtt_epar in the output of: https://bnpparibas-api.openbankproject.com/obp/v2.0.0/search/warehouse/q=_index:20170531-individual-clients+AND+customer_id:76

  • Get total income in the last year (2016) for one customer: Check field mtt_rvn_annuel in the output of: https://bnpparibas-api.openbankproject.com/obp/v2.0.0/search/warehouse/q=_index:20170531-revenues+AND+customer_id:63477+AND+annee_rvn:2016

  • Get all private asset records for a specified customer: https://bnpparibas-api.openbankproject.com/obp/v2.0.0/search/warehouse/q=_index:20170531-assets+AND+customer_id:139468+AND+categ_ptmn:1

SMEs

  • Get total number of transactions in the a given month for counterparty JAITOKEI.X: Check hits.total in the output of: https://bnpparibas-api.openbankproject.com/obp/v2.0.0/search/warehouse/q=_index:20170531-sme-transactions+AND+counterparty_name:JAITOKEI.X+AND+transaction_date:%5b2013-11-01+TO+2013-11-30%5d

  • Get names of all SMEs which have a 'very low' default risk: Check field name in the output of: https://bnpparibas-api.openbankproject.com/obp/v2.0.0/search/warehouse/q=_index:20170531-sme-client+AND+risk_default1:D0

Individuals (using OBP v3.0.0)

*Get all private asset records for a specified customer:

https://bnpparibas-api.openbankproject.com/obp/v3.0.0/search/warehouse/q=_index:20170531-assets+AND+customer_id:139468+AND+categ_ptmn:1

or

https://bnpparibas-api.openbankproject.com/obp/v3.0.0/search/warehouse { "es_uri_part": "/_search?q=_index:20170531-assets+AND+customer_id:139468+AND+categ_ptmn:1", "es_body_part": {} }

SMEs (using OBP v3.0.0)

Coming soon...

For more information about Elastic Search query syntax see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax

  1. If you have questions please post to the api_sandbox_support channel on bnpp-intnl-hacktn2017's Slack.

For a list of field names available to search please use the private slack channel here

Application registration

You will need to register your application here. You will get a consumer key and consumer secret for the calls requiring OAuth or Direct Login authentication.

Direct Login

For hackathon situations, unless you are already familiar / connected to our OAuth server, we recommend Direct Login. See the Direct Login instructions here

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. bnpparibas-api.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.

API documentation

  • For the current stable API version see 1.4.0.

  • For the latest version (recomended) see 2.2.0

Customer logins

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

Here are some example logins (user_name / password) to test your Direct Login or OAuth flow:

"users":[{
  "user_name":"Robin.Fr.12",
  "password":"X!d11d59c6",
  "email":"robin.fr.12@x.y"
},{
  "user_name":"Suzanne.Fr.12",
  "password":"X!b0c0d6cf",
  "email":"suzanne.fr.12@x.y"
},{
  "user_name":"Nathan.Fr.12",
  "password":"X!499d84e5",
  "email":"nathan.fr.12@x.y"
},{
  "user_name":"Elise.Fr.12",
  "password":"X!a6fd5046",
  "email":"elise.fr.12@x.y"
},{
  "user_name":"Roberto.It.12",
  "password":"X!1ed98d9e",
  "email":"roberto.it.12@x.y"
},{
  "user_name":"Susanna.It.12",
  "password":"X!b64b7940",
  "email":"susanna.it.12@x.y"
},{
  "user_name":"Alfio.It.12",
  "password":"X!c7c2e872",
  "email":"alfio.it.12@x.y"
},{
  "user_name":"Elisa.It.12",
  "password":"X!8da3e981",
  "email":"elisa.it.12@x.y"
},{
  "user_name":"Robert.Be.12",
  "password":"X!d7fc9f52",
  "email":"robert.be.12@x.y"
},{
  "user_name":"Susan.Be.12",
  "password":"X!e998d32f",
  "email":"susan.be.12@x.y"
},{
  "user_name":"Anil.Be.12",
  "password":"X!74089477",
  "email":"anil.be.12@x.y"
},{
  "user_name":"Ellie.Be.12",
  "password":"X!178983c2",
  "email":"ellie.be.12@x.y"
},{
  "user_name":"Robert.De.12",
  "password":"X!2b63b782",
  "email":"robert.de.12@x.y"
},{
  "user_name":"Susan.De.12",
  "password":"X!76146a1f",
  "email":"susan.de.12@x.y"
},{
  "user_name":"Anil.De.12",
  "password":"X!5691216b",
  "email":"anil.de.12@x.y"
},{
  "user_name":"Ellie.De.12",
  "password":"X!eeb323af",
  "email":"ellie.de.12@x.y"
},{
  "user_name":"Robert.Uk.12",
  "password":"X!5ecef64d",
  "email":"robert.uk.12@x.y"
},{
  "user_name":"Susan.Uk.12",
  "password":"X!88db96fd",
  "email":"susan.uk.12@x.y"
},{
  "user_name":"Anil.Uk.12",
  "password":"X!c27630da",
  "email":"anil.uk.12@x.y"
},{
  "user_name":"Ellie.Uk.12",
  "password":"X!dd9c11a8",
  "email":"ellie.uk.12@x.y"
},{
  "user_name":"Robert.Sg.12",
  "password":"X!5bb95507",
  "email":"robert.sg.12@x.y"
},{
  "user_name":"Susan.Sg.12",
  "password":"X!02a816e4",
  "email":"susan.sg.12@x.y"
},{
  "user_name":"Anil.Sg.12",
  "password":"X!6667cb40",
  "email":"anil.sg.12@x.y"
},{
  "user_name":"Ellie.Sg.12",
  "password":"X!a41b22fb",
  "email":"ellie.sg.12@x.y"
},{
  "user_name":"Robin.Lu.12",
  "password":"X!72eebc7b",
  "email":"robin.lu.12@x.y"
},{
  "user_name":"Suzanne.Lu.12",
  "password":"X!0c61bab9",
  "email":"suzanne.lu.12@x.y"
},{
  "user_name":"Nathan.Lu.12",
  "password":"X!7a4c7861",
  "email":"nathan.lu.12@x.y"
},{
  "user_name":"Elise.Lu.12",
  "password":"X!dd064e96",
  "email":"elise.lu.12@x.y"
}],

Note: In order to access the proper simulated accounts, please ask a member of the Open Bank Project team for a login. 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.