Flanks
Search…
⌃K

API Platform

An online tool to configure your integration with flanks

About the API Platform

The Flanks Platform is an online tool which enables you to interact with our API in a friendly way.
Once logged in, you can create apps and upload your CSS configuration for the Flanks Link.

Getting started

In order to gain access to the platform, you must create an account. Go to platform.flanks.io/signup and fill the signup form:
Shortly after your signup, you will receive a confirmation email with a link to verify your account:
From now on, you can go to https://platform.flanks.io/login and use your credentials to access the platform.

Apps

From this panel, you will be able to manage all your apps.

Creating an app

Clicking on Create app will show a modal; after giving it a name, your app will be ready. You can now use its CLIENT_ID and CLIENT_SECRET credentials.

Using an app

From an app tile, click on View to manage it. In addition to the credentials, you can also add several callback URLs and create a link for your clients.
An app link is a fast, easy way to allow your users to authenticate with the Financial institution throught Flanks platform. You can create them from an app.
A link provides a fast and secure authentication flow which enables your end users to authenticate with their banking platforms. You can easily integrate a link into your applications and start retrieving your end users' financial data. Links are unique and static so they can be reused for all your clients. You might create different links for different your different environments (development, production).

Managing redirect URIs

From your app settings page, you can manage its redirect URIs. Since a link must use a redirect URI, you have to create one first.
Click on the blue box to add a new redirect URI.
Enter a well-formed URI and save.
You can add as many redirect URIs as you desire.
You can also delete existing redirect URIs by clicking on Delete.
Click on the red box to confirm delete.
After the user has introduced their online banking credentials and Flanks system has verified their are correct the user will be redirected to the redirect URI associated to the link used by the user.
Click on Generate link and select one of the app redirect URIs. Your link will be generated:
Select a redirect URI.
After generating a link, any client can use it to introduce credentials in order to authenticate against their banking platform.
Adding extra parameters to a Link
A link resembles the following schema:
https://platform.flanks.io/link?token=<LINK_TOKEN>&bank=<BANK_ID>
bank=<id>
The id of the desired bank, to redirect user to the form, instead of showing all available bank option. This id is retrieved from GET to /v0/bank/available.
sca_token=<string>
The string value is the one returned by v0/bank/credentials/status. And it will reduce friction avoiding user to introduce username and password again, directly SCA value will be required. If you use this parameter you also have to provide the bank parameter.
reset_token=<string>
The string value is the one returned by v0/bank/credentials/status. And it will allow user to reintroduce username and password, mantaining the credentials_token.
transaction_token=<string>
The string value is the one returned by v0/credentials/status endpoint. This parameter in the URL enables Flanks system to go backwards 90 days in the user transactions. If you use this parameter you also have to provide the bank parameter.
You can add extra querystring parameters, which can be retrieved later.
For instance, if you add extra parameters before sending the link to your clients, like this:
extra parameters are useful in order to determine which of your users connect the entity. So you can associate the credentials_token obtained from Flanks to your internal user identifier.
All the extra parameters will be in the EXCHANGE LINK CODE FOR CREDENTIALS TOKEN endpoint response, under extra field.
After a successful login, the end user will be redirected to the redirect URI specified when creating the link. A code querystring parameter will be appended to the redirect URI:
http://your.redirect.uri?code=an-auto-generated-code
Now you can recover the code parameter from the querystring.
In some cases, your redirect URI will look like this:
http://your.redirect.uri?code=an-auto-generated-code&delayed=true
The delayed=true indicates that several security checks are performed before you can obtain your final token. Don't worry, it doesn't last more than 72h.
The final step is to exchange this code for a credentials_token, which can be done via the EXCHANGE LINK CODE FOR CREDENTIALS TOKEN endpoint. The code is one-use, so ensure you properly save the resulting credentials_token.
The process will be finished and a credentials_token will be added to your Users panel.

Mobile integration flow

When integrating Flanks Link with a mobile device, you cannot rely on the code parameter being appended to your redirect URI. This is why you should use the following schema:
  1. 1.
    Create an App and add a redirect URI.
  2. 2.
    Create a Link.
  3. 3.
    Add the extra querystring parameters needed to properly identify your clients.
  4. 4.
    Use the GET LINK CODES endpoint to retrieve all unused link_codes.
The EXCHANGE LINK CODE FOR CREDENTIALS TOKEN will return all your additional parameters under the extra attribute. Then, you can use those parameters to identify to which client does the credentials_token correspond.

Managing users

All the credentials_token created from a link will appear here.
You can now use those credentials_token to retrieve all financial data.
When a bank ask for two-factor authentication, in every login or every given number of days, the login access must be reauthorized. This flow requires user interaction again.
You can detect if reauthorization is needed when the value of sca_token field return by Flanks API endpoint is not null.
You must redirect your client to a URL resembling to this one https://platform.flanks.io/link?token=<LINK_TOKEN>&sca_token=<SCA_TOKEN_VALUE>&bank=<BANK_IDENT>&...
Where:
  • sca_token: is the value returned by /credentials/status enpoint
  • bank: it is the id field of the /banks/available endpoint matching to the credentials_token
You can also pass extra query parameters as explained in Using links to connect to banks. When users are redirected to this URL, Flanks will ask them only for the value of the SCA. After introducen the value and if everything goes right, Flanks will redirect your user to the configured redirect_uri of your App with a code querystring added. This code should be used as exchange for the credentials_token and extra parameters in order you can identify your client.
*The credentials_token will not change.
You can edit the default style of the Flanks link by uploading a CSS file including the custom colors you want. To do so, access https://platform.flanks.io with your credentials and click Custom CSS icon (https://platform.flanks.io/cssedit).
Custom CSS icon

Creating custom style

Inside this page, drag and drop or browse your files in order to upload the custom CSS file:
Custom CSS section
Here you have an example CSS file. Our link elements have an ID so that it's easiler to style them, for this reason we recommend you to use these ID's when creating the custom style.
#title-select-bank {
color: #78281f !important
}
#background {
background: #CD5C5C;
}
#div-select-bank {
background: #f5f5f5;
}
#input-search-bank {
background: #fadbd9 !important
}
#bank-box {
background: #fadbd9;
}
#bank-img {
background: transparent;
}
Then, you have to generate a link if you don't have one, in order to access the popup with your custom style. This style will be applied in all the applications created.
Custom styled popup

Restore the default theme

You can restore the default theme at any time. For that purpose, go to the Custom CSS section and click on the right button Restore default theme: