BNP Paribas OBP API Sandbox

Simon Redfern edited this page Jun 30, 2016 · 62 revisions

Hello!

This is a special page for the BNP Paribas OBP API sandbox created for the BNP Paribas International Hackathon on June 17-19 2016 in Brussels, Istanbul, Paris, Rome, Berlin, London and San Fransisco.

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 contact@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 https://bnpparibas-apiexplorer.openbankproject.com/#2_0_0-elasticSearchWarehouse

Available types in the warehouse:

  • Types at index production001: CUSTOMER, TRANSACTION, YEARLY_CUSTOMER_CHARGE, CONTRACT, CUSTOMER_DECLARED_PRODUCT, CUSTOMER_TAX, ASSET, INCOME, SME, MARKET

Search Warehouse examples:

To get all TRANSACTIONs:
 /search/warehouse/df=_type&q=TRANSACTION

To page through all transactions (use size=1 and from=n). 
Note: q is required. The default field (df) is set to _type. Thus we search for records of type TRANSACTION:
https://bnpparibas-api.openbankproject.com/obp/v2.0.0/search/warehouse/df=_type&q=TRANSACTION&size=1&from=34

To page through transactions of one particular customer, sorted by date:
https://bnpparibas-api.openbankproject.com/obp/v2.0.0/search/warehouse/esType=TRANSACTION&q=customer_id:000000000000000502&size=2000&from=1&sort=transaction_date

To get all ASSET records for a specified customer: 
 /search/warehouse/esType=ASSET&df=customer_id&q=000000000000262237

To get CUSTOMERs from the production002 index use:
 /search/warehouse/esType=CUSTOMER&q=_index:production002

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

8) If you have questions please post to the BNPP-ih-2016 channel on Slack.

For a list of fieldnames 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.3.0.

  • For the latest version (recomended) see 2.0.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 (email / password) to test your Direct Login or OAuth flow:

"email":"robin.fr.04@example.com",
"password":"ed8992",
"display_name":"Robin Fr.04"

"email":"suzanne.fr.04@example.com",
"password":"29200a",
"display_name":"Suzanne Fr.04"

"email":"nathan.fr.04@example.com",
"password":"ca577d",
"display_name":"Nathan Fr.04"

"email":"ellie.fr.04@example.com",
"password":"3a02dd",
"display_name":"Ellie Fr.04"

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?