The flinks-doc Developer Hub

Welcome to the flinks-doc developer hub. You'll find comprehensive guides and documentation to help you start working with flinks-doc as quickly as possible, as well as support if you get stuck. Let's jump right in!

Parameters

All customizable options for design and functionalities are controlled by the parameters that are entered directly as URI parameters into the iframe URL.

Here's an example:

https://toolbox-iframe.private.fin.ag/?demo=true&redirectUrl=https://flinks.io/contact/thank-you&innerRedirect=true&theme=light&consentEnable=true&customerName=FinTech&backgroundColor=f7f7f7&foregroundColor1=000000&desktopLayout=true&headerEnable=false&institutionFilterEnable=true

All parameters and options available to you are described below:

Layout Customization

Parameter Default Value Valid Values
theme dark dark, light
desktopLayout false true, false
institutionFilterEnable false true, false
closeEnable false true, false
headerImgEnable true true, false
headerEnable true true, false
backEnable true true, false
fixedHeightEnable true true, false
boxLayout true true, false
loadingType dots dots, progressbar

Theme

Flinks Connect support both light and classic (dark) themes for the Institution Selection menu and Institution Login page. While the changes only affects Flinks Connect layout, the main difference between themes are related to the Institution Selection menu, Institution Login page and default background colour.

Light Theme

Institution Selection menu:

Institution Login page:

Classic (Dark) Theme

Institution Selection menu:

Institution Login page:

Desktop Responsive Layout

To enable the browser responsive layout for the Institution Selection menu, you need to specify the parameter desktopLayout=true.

Institution Filter

To add a search bar into the Institution Selection Menu, you need to specify the parameter institutionFilterEnable=true.

Removing buttons and header

You can remove the back button from the Institution Login page by specifying the parameter backEnable=false. This is particularly useful for integrations that have a custom Institution Selection page.

You can remove both text and image from the header by specifying the parameter headerEnable=false, or just remove the image by specifying headerImgEnable=false.

Disable mobile fixed height

If the parameter fixedHeightEnable=false is specified, the fixed height (767px and under) on the institution selection page will be removed.

Close Button

You can give your users more flexibility and control by adding a close button directly to the Institution Login page. To enable the close button, specify the parameter closeEnable=true. If the button is clicked, Flinks Connect will show the event {step: "COMPONENT_CLOSE_SESSION", institution: "FlinksCapital"}.

Please note that this button doesn't perform any action directly in Flinks Connect besides the event in the Event Listener.

Login Page Box

If the Light Theme is being used but the desired Institution Login page layout is from the Classic theme, the parameter that needs to be added is boxLayout=true.

Loading Type

By default the dots animation is the one presented while Flinks processes the Authorize request. If you prefer using a more classic progress bar, specify the parameter loadingType=progressbar needs to be added.

Language

Parameter Default Value Valid Values
language en en, fr

Flinks Connect supports both English (default) and French languages for the interface. All requests initiated by Flinks Connect attempt to connect to the Financial Institution in the chosen Flinks Connect Language, which means that the Multifactor Authentication can also be prompted in the same language.

To activate the French version of Flinks Connect, the parameter language=fr must be specified.

Colors

Parameter Default Value Valid Values
backgroundColor false Hex Color Code
foregroundColor1 TransactionHistory, AccountNumber and AccountInfo Hex Color Code
foregroundColor2 none-set Hex Color Code

This parameter helps you integrate Flinks Connect while maintaining the user experience and continuity that fit your brand.

Here, we played with the background and foreground colours of the Institution Selection menu:

User Consent

Consent Page

Parameter Default Value Valid Values
consentEnable false true, false
features TransactionHistory, AccountNumber and AccountInfo TransactionHistory, AccountNumber and AccountInfo

Flinks Connect has an optional Consent Page that can be enabled to explicitly ask the end user for data access consent.

Each type of data accessed is listed on this page and the end user will only be able to proceed with the account connection if consent is given. This page will be displayed after the institution is selected, and before the Institution Login page.

Depending on the use-case not all types of data are collected. You might then want to limit the scope of the consent. Specify the Flinks features and their order on the list using the parameter feature.

By default all possible features are listed:

Here’s an example of a consent page with a limited scope for Flinks features and modified order:

In this example, the parameter features=AccountInfo,AccountNumber was specified.

List Order

The specified order of values for the features parameter will affect the order of the shown list.

Terms and Conditions

Parameter Default Value Valid Values
termsUrl none-set string
termsNoCheckbox false true, false
customerName none-set string

If the end user has not accepted your service's terms and conditions in a previous step, you will need to add them on the Institution Login page. You can do so using the following parameters:

termsUrl: display the URL of your service terms, so your user can access them from the Institution Login page.

termsNoCheckbox=true: if set, this parameter will remove the checkbox but still show the terms and conditions text.

customerName: display name of your company, as you want it to appear in the Institution Login page for the terms sentence.

Enhanced Multi-factor Authentication

Parameter Default Value Valid Values
enhancedMFA false true, false
skipEnhancedMFA false true, false
withMFAQuestions false true, false

If your use-cases requires automatic account refresh, we recommended you use the Enhanced MFA flow. To activate this feature, the parameter enhancedMFA=true must be specified.

During the Authentication step, Flinks will attempt to extract all additional MFA Questions and Answers, besides the one that is commonly prompted in the first time connection.

Flinks will prompt the user to preemptively answer all additional questions. If you want to give the end user the option to skip this step, add the parameter skipEnhancedMFA=true.

If you have a custom integration with Flinks to manually handle the Enhanced MFA flow via the API, then you only need to specify the parameter withMFAQuestions=true.

Please note that the enhanced MFA only works for Simple Security Questions, and special MFA such as 2step verification are not supported for this feature.

Redirect

Parameter Default Value Valid Values
redirectUrl https://flinks.io/contact/thank-you/ [string URL]
innerRedirect false true, false
jsRedirect false true, false

Flinks Connect will redirect the end user to a landing page once their account was successfully connected.

We recommend to set the Redirect URL to your custom landing page, which can be a Thank You page or a landing page specific to the next step in your process.

If the parameter redirectUrl is not specified, a generic Flinks hosted Thank You page https://flinks.io/contact/thank-you/ will be set, along with the parameter innerRedirect=true.

In case the language is set to French by using the parameter language=fr, the Thank You page https://flinks.io/contact/merci/ is going to be set as default.

Account Selection

Parameter Default Value Valid Values
accountSelectorEnable false true, false
fetchAllAccounts false true, false
eftEligibleRatio 0.8 0.0 to 1.0
showAllOperationsAccounts false true, false
accountSelectorCurrency cad,usd cad or usd

Add the parameter accountSelectorEnable=true to enable the Account Selection feature in Flinks Connect.

After a successful authorization with the financial institution, Flinks Connect will prompt to the end user a summary of operations accounts that are eligible for Electronic funds transfer (EFT).

If you want to present your end user all operations accounts, even those not eligible for EFT, use the parameter showAllOperationsAccounts=true.

By default, Flinks Connect only collects the details of the selected account, but it is possible to still gather all accounts details by specifying the parameter fetchAllAccounts=true.

Example of the redirected URL when the Account Selector is enabled:

https://example.com/?loginId=f5d5f008-e529-4714-21c0-08d6abf5bce4&accountId=81cea6a2-b156-49d9-3e9c-08d6abf5c58e&institution=FlinksCapital

When this feature is enabled, the AccountId of the selected account is going to be included in the redirected URL and the Event Listener, along with the LoginId.

Use Cases

Range of Transactions

Parameter Default Value Valid Values
daysOfTransactions Days90 Days90, Days365
withTransactions true true, false

By default, Flinks Connect extracts Transactions history data for the last 90 days. It is possible to increase its range to a full year, or configure it to avoid extracting transactions altogether.

To increase the range to a full year, you need to specify the parameter daysOfTransactions=365Days. To avoid extracting Transactions history, specify the parameter withTransactions=false.

PDF Statements

Parameter Default Value valid values
statement false true, false

In case you want to retrieve bank-issued PDF statements for the last 90 days instead of accounts details in a JSON format, specify the parameter statement=true.

We Will Unlock That for You

If you want to use this feature, please contact our support so we can enable it in your private instance.

Nightly Refreshes

Parameter Default Value valid values
scheduleRefresh false true, false

If your use-case requires automatic account refresh to keep track of transactional history changes, you can enable the nightly refresh for new accounts. For this, you need to specify the parameter scheduleRefresh=true.

Fees may apply for nightly refreshes.

Tag

Parameter Default Value valid values
tag none-set {string}

It is possible to add a custom tag to a specific connected account which will be later returned into the API or with a webhook callback response.

This feature can be useful when reconciling Flinks LoginIds with end users, for example.

Wait Summary

Parameter Default Value Valid Values
waitSummary false true, false

If your flow is set so the Flinks Connect redirect is required to happen only after the GetAccountsSummary process is completed, you need to add the parameter waitSummary=true. This is mostly needed for flows where the account selection feature is not handled by Flinks Connect in a custom integration.

MaximumRetry

Parameter Default Value Valid Values
maximumRetry 99 1 to 99

By default, Flinks Connect doesn't limit the number of times the end user can attempt to enter their login credentials. You can limit these attempts in order to prevent your end user from being locked out of their account for entering the wrong credentials too many times. Specify the maximum number of attempts by using the parameter maximumRetry.

Sync - Authorize Only

Parameter Default Value Valid Values
sync false true, false

Some custom integrations for very specific use-cases might need Flinks Connect exclusively for handling the Authorize process — and not the data extraction as usual. To enable this mode, specify the parameter sync=true.

Attention!

Before using this feature, let's make sure you really need it. Drop a message to our Support Desk at help@flinks.io.

Stringify

Parameter Default Value Valid Values
stringify false true, false

If you need to have all your events from the Event Listener as strings instead of JSON, specify the parameter stringify=true.

Session Storage

Flinks Connect relies on the session storage feature from your users' browser in order to work properly.

If we detect that the browser does not support this feature we will prevent Flinks Connect's usage and display a message explaining why. Flinks Connect will also trigger the JS event {step: "SESSION_STORAGE_BLOCKED" }.

Another JS event is triggered when the user clicks on the retry button {step: "SESSION_STORAGE_BLOCKED_RETRY" }. The parent page (not the iFrame) needs to be reloaded if this event is triggered.

If the user activates the cookies / session storage feature, the browser will reload the parent page and the iframe will work as expected.

We use the word cookies in the message because most browsers will disable session storage when disabling cookies.

Example for reloading the page if {step: "SESSION_STORAGE_BLOCKED_RETRY" } is triggered:

<iframe src="https://demo.flinks.io/?redirectUrl=https://example.com" id="frameFlks" width="800" height="800"></iframe>
<script>
    window.addEventListener('message', function(e) {
        console.log(e.data)

        if (e.data.step == 'SESSION_STORAGE_BLOCKED_RETRY') {
            location.reload();
        }
    });
</script>

What's Next

Now that you have the full list of possible parameters, you can either configure the main options, or understand more about the Events for you to have the full control over your user experience.

Configure and Install Flinks Connect
Events
Start your Integration

Parameters


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.