Using the Platform

An online tool to test and interact with Flanks API

About the 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 manage your bank accounts, create apps, access different services, and much more.

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.

Dashboard

The dashboard synthesizes all your product information so you can gain at-a-glance insight about all your products.

Creating and managing accounts

From the Accounts panel, you can manage your test accounts:

You can also create a test account by clicking on the Create account button:

Your new account will be added to the account list.

Creating and viewing account transactions

From a test account, you can create test transactions. Locate your desired account tile and click on View. You'll access the transaction list:

You can click on the Add transaction button to add a new transaction to the account. A popup will be shown:

Your newly added transaction will be added to the test account and its balance will be updated accordingly.

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.

Using links to connect to banks

An app link is a fast, easy way to allow your clients to authenticate with the 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.

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.

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 authenticate with 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 retrieve 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:

https://platform.flanks.io/link?token=<LINK_TOKEN>&myparam=<MY_VALUE>&otherparam=<OTHER_VALUE>

All the other parameters will be in the EXCHANGE LINK CODE FOR CREDENTIALS TOKEN endpoint response, under extra.

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. Create an App and add a redirect URI.

  2. Create a Link.

  3. Add the extra querystring parameters needed to properly identify your clients.

  4. Use the GET LINK CODES endpoint to retrieve all unused link_codes.

  5. Use the EXCHANGE LINK CODE FOR CREDENTIALS TOKEN endpoint.

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.

Hooks

Flanks Hooks allows you to get notified when event occurs.

In order to enable hooks, access https://platform.flanks.io with your credentials and click Hooks icon.

Hook Icon

Periodically our system check every defined hook and if condition established is accomplished our system will POST the specified callback URL the following body:

{
"credentials_token_list": [ str , ... ],
"event": str, // The event is the name of the Hook
"timestamp": DateTime
}

Default hooks

  • Blocked user: You will get notified if user is blocked.

  • Re-authorization required: Detect if re-authorization is required.

  • Available data: Get notified when credentials data becomes available.

Next you can create a hook by clicking on Create Hook + button and fill in input form. You could choose to enable one of the default hooks or create your custom one (coming up soon).

Creating default Blocked user hook

If all goes right you will see that the hook will now appear in your Hooks page.

Created hooks list

If you want to update a hook, just click on View > , edit the desired field by clicking on edit icon placed next to the input field. And finally click on Save Hook button.

Edit default hook page

Custom Hooks

You can also create a hook with a custom condition by clicking on the checkbox in create hook form. You must select field, operation and the desired value.

Custom hook creation

You will be able to update your custom condition in every moment inside the desired custom hook page.

Custom hook edit page