left logo image
right logo image
Skip to main content Skip to main content Skip to main content Skip to main content Skip to main content Skip to main content

Welcome to the JOIN FINCUBATOR API Sandbox

API Sandbox Introduction

This sandbox is powered by the Open Bank Project / TESOBE and provides a solid and enterprise-ready infrastructure for unleashing innovation in the cloud.

The sandbox comes with over 500 RESTful JSON endpoints to help you imagine, develop and demonstrate your application and business solutions.

Using this sandbox, participants can register and request access to specific APIs. Developers can on-board themselves following a few simple steps via the portal page. Developers can even create their own “Banks” and then create and manage all entities related to it. The API Sandbox also provides a number of SDKs (Software Development Kits) and code samples that developers can use to kick-start their implementation in their programming language of choice.

API Sandbox capabilities

The sandbox contains several different categories of APIs, data and functions:

  1. You can create your own "Banks". By creating a Bank, you, the developer, can create records in any object in the OBP data model. Please see https://obp-apiexplorer.joinfincubator.com/?version=OBPv5.1.0&operation_id=OBPv5_0_0-createBank&currentTag=Bank&locale=en_GB#OBPv5_0_0-createBank. Note: When you create a bank you can grant yourself roles but you must still grant them to yourself. Once you have created a bank, you can use the API Manager (or API Explorer) to give yourself roles HERE. Having created your own bank, you have full control of everything inside it. For instance you can create financial Products, Accounts, Customers, Transactions and Branches under a Bank that you create.
  2. You can use the provided synthetic data which is accessed by using dummy customer logins - These logins allow you to easily authenticate and retrieve bank accounts and transactions over the API. Please see HERE or below.
  3. You can add extra information / fields to the core OBP data model. For instance if you want to store a certain field for a Customer, you can add a Customer Attribute. If you want to add some more information to a Transaction, you can add a Transaction Attribute.
  4. You can create your own data tables over the API via Dynamic Entities. These can be created at the bank level, so users can see the same data. Or, you can create Personal Dynamic Entities in which case users each create and see only their own data. For example, say your App needs to store some specific personal information for each logged in user, then your App could use one or more Personal Dynamic Entities to store this data. If your App needs to store some special Bank related information that is not covered by existing OBP APIs, say a list of marketing events, you could create a “Marketing” DynamicEntity and your App would read and write to that Dynamic Entity over the RESTful APIs.
  5. You can define your own endpoints by submitting an Open API / Swagger file. These endpoints can either return mocked data, or you can configure them to call backend APIs.

As well as the APIs mentioned above, the Portal provides:

  1. User interfaces (and matching REST APIs) you may use to:
  • Register yourself as a developer
  • Get API keys for your Apps
  • Discover, call and create APIs
  • Request access to Roles
  • Grant Roles to others
  1. Links to SDKs and example apps to get you started with your own apps

Synthetic Data

This sandbox contains a structured, simulated data set containing banks, accounts, and transactions to help developers iterate new solutions. No real customer data is included here! After registering for an API key, developers can easily access data that contains:

  • Accounts
  • Transactions
  • Customers
  • Counterparties

Uploading your own data

Developers can create their own banks and create entities such as Products and Customers under each “bank”.

For an example of a Python script which uploads data into various OBP entities, please see HERE

Participants can also upload additional data using the following approaches:
* Create records in the OBP data model. Discover endpoints using the API Explorer HERE.
* Create OBP Custom Attributes for Customer, Product, Account, Transaction etc. Please see below.
* Create OBP Dynamic Entities and Personal Dynamic Entities. Please see HERE

Some OBP standard model and OBP attribute examples are listed below:

  1. Create Customer: This endpoint enables the user to create a new Customer. The Customer resource stores the customer number (which is set by the backend), legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc. Please see HERE.
  2. Create Customer Attribute: This endpoint enables the user to create a new attribute for the OBP object “Customer”. Please see HERE.
  3. Create Account: This endpoint enables the user to create a new Account at a bank specified by BANK_ID. Please see HERE.
  4. Create Product Attribute: Product Attributes are used to describe a financial Product with a list of typed key value pairs. Accounts inherit the attributes of its Product. Each Account Attribute is linked to its Account by ACCOUNT_ID. Please see HERE.
  5. Create Account Attribute: This endpoint enables the user to create a new attribute for the OBP object “Account”. Please see HERE.

A typical developer journey

  1. Register yourself as a developer:
    https://obp-apisandbox.joinfincubator.com/user_mgt/sign_up
  2. Get an API Key - this means registering a consumer app that will call the API:
    https://obp-apisandbox.joinfincubator.com/consumer-registration
    Be sure to copy the API Key and also user credentials.
  3. Use the user credentials from Step 2 to log on to the API Explorer and then call the APIs:
    https://obp-apiexplorer.joinfincubator.com
  4. Use the user credentials from Step 2 to call the APIs from your own app or other REST client. You can use the API Explorer to request Roles if you don’t already have them. These are granted by admin members using the API Manager:
    https://obp-apimanager.joinfincubator.com

Start building your app

We highly recommend using Direct-Login!

OAuth1 and OAuth2 authentication is also available. Please see OAuth1 and OAuth2.

Tips

Feel free to use the following helper applications in addition to the API Explorer and API Manager.

The API Tester can be used to repeatedly call endpoints on the sandbox. Please see HERE.

Sofit is a web application that can display accounts and transactions. Please see HERE. Feel free to try it with the dummy customer logins above.

Customer Logins

Developers can use the following login details to get access to test customer accounts and dummy transactions:
(see also HERE)

Rami.Jo.01 / X!72b8b27f
Zahra.Jo.01 / X!649e65c8
Asil.Jo.01 / X!66f10a1c
Alia.Jo.01 / X!943ce6cd
Meriem.Jo.01 / X!124a95d2
Yusuf.Jo.01 / X!b15dd866
Walid.Jo.01 / X!38cc4691
Yasmine.Jo.01 / X!53646eb0
Amina.Jo.01 / X!a1b6d700
Samir.Jo.01 / X!ef3a7bde
Othman.Jo.01 / X!c0e6f6bb
Khalil.Jo.01 / X!2cc96ce9
Amir.Jo.01 / X!42da4265
Elissa.Jo.01 / X!21f09526
Eleanor.Jo.01 / X!1d93b5e7

SME Business logins:

Rami.Jo.03 / X!900e1d60
Zahra.Jo.03 / X!5b1447b4
Asil.Jo.03 / X!8bbaddb9
Alia.Jo.03 / X!84c7511a
Meriem.Jo.03 / X!61f4db9d
Yusuf.Jo.03 / X!ddcc4cc6
Walid.Jo.03 / X!df1d6edd
Yasmine.Jo.03 / X!7e69837d
Amina.Jo.03 / X!ff2cc299
Samir.Jo.03 / X!4a15ec51
Othman.Jo.03 / X!1cd4a389
Khalil.Jo.03 / X!90861b82
Amir.Jo.03 / X!34a34715
Elissa.Jo.03 / X!b46d1969
Eleanor.Jo.03 / X!01e9db25