Cookies

This website uses cookies for proper functioning of all its tools and features. To know more about cookies, read our Privacy policy

I accept cookies from this website

Hide

Developer Portal

 

Path to API access

This is an overview show you an overview of the steps that need to be taken to integrate PSD2 API Hub with your services and applications. They are shown in the diagram and explained in detail below. You can work on the Sandbox API without signing an agreement with us.

 

The contractual path is only required for working with the production API.

 

grafika1 15

Developer Portal Registration

Registration on the Developer Portal is necessary as it gives you access to our documentation and the sandbox environment. After registering you need to subscribe to the selected product and then, after verification, you will receive credentials necessary to use a sandbox.

 

Link to the Developer Portal : Developer Portal

 

subscribe1

 

Sandbox API Access

After you register, you gain access to the sandbox API. Our sandbox is provided to test the integration to our APIHub and to allow you a deeper understanding of how the API works. The Sandbox supports a full, end-to-end experience for multiple banks and has been fully tested with our QA team. The solution is created to be easy to use, so we hope you will not get stuck.

System Integration

With the sandbox, you can comfortably test connecting to banking sandboxes, register and test your callbacks, redirect urls and see how the actual financial data is formatted. We will not serve you mock data or hardcoded values - what you get is actual data from banking sandboxes. There may be differences between sandboxes and production environments of banking APIs, or other API aggregator solutions but with our API it is not the case. We compile different APIs into one to deliver a seamless and consistent experience between different environments. Integration with our API is an easy process.

Signing the contract

In order to use actual banking data and our TPP License, we need you to meet legal requirements. This involves a signed contract between you and banqware in order to establish a formal relationship that will allow us to give you access to production APIs and actual financial data of your customers.

Production API Access

With a signed contract, we can start the process of connecting you to our production environment. We will need a few items to finalize this:

  • certificate generated by the CSR you provide based on our guidelines, which we will use to verify your identity when connecting to our Production API
  • list of IP addresses that we will add to our whitelist, and which will have access to our Production API

After the process is finished you can access actual financial data of multiple banks through our API and go live with Open Banking.

First steps in the system

When using banqUP’s APIHub you don't connect to banking AIS APIs directly. Nor you connect to them indirectly. In order to unify the flows provided by multiple banks and multiple standards, we synchronize them "under the hood" then save the data in our internal persistent store. After the data is updated, you can access general financial data or identity verification data using either our Account Info API or KYC API respectively.

 

In order to access data you only need to follow a few simple steps described below which depend on Sync API. These steps are necessary to fill our internal storage with your data

 

Related resources are:

  • Management resources
  • User resources
  • Consent resources
  • Update resources

Authorization

Obtaining authorization is the first step, however we cannot inform you about the process in the public document. To find out how to authorize our API please visit Security section in the developer portal.

Callbacks

When you get access to the APIHub, the first action to be taken is to register redirect urls (mandatory) and callback urls (optional). In order to register or update urls you can use below method.

 

    curl -X PUT 
    "https://api.banqware.com/sandbox/management
    -resources/api/tenant/urls"
    -H "accept: application/json"
    -H "Content-Type: application/json"
    -d "{\"redirectUrls\":[\"string\"],
    \"updateCallbackUrls\":[\"string\"]}"



When creating either consent or update resource later on, you will be able to pass one of the registered urls. You can also register a list of redirects so that you will be able to use our sandbox and production APIs using different environments and different setups.

User account

All the other endpoints have to be applied to the user account, so we need to create a user first. ClientId is an optional user's identifier. You can use it interchangeably with a UserId given by us. If you want to create it, follow the below method

 

    curl -X POST
    "https://api.banqware.com/sandbox/user
    -resources/api/user"
    -H "accept: application/json"
    -H "Content-Type: application/json"
    -d "{\"clientId\":\"\"}"

Customer's consent

In order to get user's consent to acquire their data you need to:

  1. Create an object representing user's consent to access data from a specific bank. The initial status of the consent is then requested.

        curl -X POST 
        resources/api/user/id//consent"
        -H "accept: application/json"
        -H "Content-Type: application/json"
        -d "{\"bankId\":\"\",\"bankIdType\":\"\",
        \"redirectUrl\":\"\"}"


    You have to pass one of the registered redirect URLs to us in order for the user to be redirected after the authentication from the bank website.

  2. Then pass the authorization URL to the customer.
  3. User uses the URL to authorize access to his or her data.
  4. User is redirected to our redirect URL.
  5. We receive code which we exchange for a token.
  6. We change consent status to given. You can check status:

        curl -X GET
        -resources/api/user/id//consent/"
        -H "accept: application/json"

     

    Now we are ready to make an updated request to ApiHub.

Data update

An update object is an abstraction representing the process of updating user data. In order to initialize an update, you need to be granted customer's consent and use the below endpoint.

 

    curl -X POST 
    "https://api.banqware.com/sandbox/update
    -resources/api/user/id//consent//update"
    -H "accept: application/json"
    -H "Content-Type: application/json"
    -d "{\"callbackUrl\":\"\"}"

 

You can either provide a callback URL on which we'll post information about the update status change or you can check the status of the update by calling the endpoint as below.

 

    curl -X GET 
    resources/api/user/id//update/"
    -H "accept: application/json"

 

Update status completed means that all the data has been fetched, processed and unified and are now available through our API endpoints. First call can take a bit longer - we're fetching as much data as we can, but every following update is just incremental.

Data access

After the update status changes to completed, you can access the account information and KYC information using account information resources and KYC resources respectively.

Delete data

When the user's data is no longer needed you can delete both the user's consent and all the data that has been acquired with this consent with the below call.

 

    curl -X DELETE
    -resources/api/user/id//consent/"
    -H "accept: application/json"

 

This is all you need to configure before making it work. If you have any questions contact us at contact@banqup.com

CONTACT

Headquarter in Belgium
Proudly developed in Poland

 

E-mail: contact@banqup.com

 

Find us: 

SM inSM FSM twet

ABOUT US

BanqUP is an API-driven platform for open banking solutions, allowing for banks and fintech companies to access a number of European banking APIs.
BanqUP helps TPPs and banks quickly access open banking ecosystem and analyze banking data, allowing them to create bold and innovative solutions, as well as cross-sell and up-sell their existing product.

Copyright 2019 © banqup.com