Parameters

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

Here's an example:

https://toolbox-iframe.private.fin.ag/v2/?demo=true&redirectUrl=https://flinks.com/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:

Version

The latest version of the Flinks Connect design can be enabled by adding /v2/ to your iFrame url.

📘

Already using version 1?

If you're an existing customer using version 1, this is still accessible to you without specifying a version.

Language

ParameterDefault ValueValid Values
languageenen, 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.

Layout Customization

ParameterDefault ValueValid Values
institutionFilterEnablefalsetrue, false
closeEnablefalsetrue, false
headerImgEnabletruetrue, false
headerEnabletruetrue, false
backEnabletruetrue, false
staticLoadingEnablefalsetrue, false

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 customize aspects of the header on the institution page:

Function

Parameter

Remove the lock image from the header

headerImgEnable=false

Remove the lock image and text from the header

headerEnable=false

User Consent

Consent Page

ParameterDefault ValueValid Values
consentEnablefalsetrue, false
featuresTransactionHistory, AccountNumber and AccountInfoTransactionHistory, 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:

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.

Institution Login page

Preselecting Institutions

It is possible to integrate Flinks Connect to be loaded directly on a specific preselected Institution Login Page, and skip the user FI selection menu.

Selecting by Institution ID

This can be achieved by adding the selected Institution ID into the iframe URL, following the current URL structure: https://[iframe-instance]/Credential/[Institution-ID]/?[parameters]

For example, to load Flinks Connect directly into Chase's Login Page (Institution ID: 20), using the sandbox instance (toolbox), the iframe URL is:

https://toolbox-us-iframe.private.fin.ag/v2/Credential/20

📘

Institutions IDs

All available Institutions and its respective details such as ID and Name can be retrieved with our Institutions API.

Selecting by Routing Number

For some US institutions, this can be achieved by specifying the selected Institution routing number and the parameter routingNumber=true into the iframe URL, following the current URL structure: https://[iframe-instance]/Credential/[routing-number]/?[parameters]&routingNumber=true

For example, to load Flinks Connect directly into Chase's Login Page (routing number: 071000770), using the sandbox instance (toolbox), the iframe URL is:

https://toolbox-us-iframe.private.fin.ag/v2/Credential/071000770?routingNumber=true

❗️

Routing numbers not found

If a given routing number does not have an associated institution within Flinks, an error will be displayed and the user will be redirected to a FI selection page.

A full list of available routing numbers can also be retrieved with our Institutions API

Close and Back Buttons

You can give your users more flexibility and control by adding a close button directly to the Institution Login page. You can see the close button in the example above in the top right of the screen.

If the close 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.

Function

Parameter

Enable the close button

closeEnable=true

Remove the back button

backEnable=false

Terms and Conditions

ParameterDefault ValueValid Values
termsUrlnone-setstring
termsNoCheckboxfalsetrue, false
customerNamenone-setstring
termsTextPreLinknone-setstring
termsTextLinknone-setstring
termsTextPostLinknone-setstring

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.

termsTextPreLink : text displayed in the terms and condition before the link

termsTextLink: text displayed in the terms and condition link

termsTextPostLink: text displayed in the terms and condition after the link

In this example, the parameter is set to `customerName=FinTech`In this example, the parameter is set to `customerName=FinTech`

In this example, the parameter is set to customerName=FinTech

Enhanced Multi-factor Authentication

ParameterDefault ValueValid Values
enhancedMFAfalsetrue, false
skipEnhancedMFAfalsetrue, false
withMFAQuestionsfalsetrue, 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

ParameterDefault ValueValid Values
redirectUrlnot-set[string URL] ex.: https://www.example.com/thank-you
innerRedirectfalsetrue, false
jsRedirectfalsetrue, 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. Any parameters you have specified in the your landing page URL must be encoded.

❗️

Parameters in your Redirect URL

You must encode all parameters that are specific to your landing page URL.

✅ Good usage: redirectUrl=http%3A%2F%2Fflinks.com%2F%3FurlEncoded%3Dtrue

❌ Bad usage: redirectUrl=https://flinks.com/?urlEncoded=true

If the parameter redirectUrl is not specified, a generic thank you page will be displayed.

Account Selection

ParameterDefault ValueValid Values
accountSelectorEnablefalsetrue, false
accountSelectorMultiplefalsetrue, false
fetchAllAccountsfalsetrue, false
accountSelectorNoTitlefalsetrue, false
eftEligibleRatio0.80.0 to 1.0
showAllOperationsAccountsfalsetrue, false
accountSelectorCurrencycad,usdcad or usd
showAllAccountsfalsetrue, false

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.

In case the text Please select an account does not fit into your use-case, you can remove it by using the parameter accountSelectorNoTitle=true, and any other desired copy can be added just above your iframe.

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

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

Example of the JS event for a selected account:

{
   accountId: ["7d213d26-d966-4229-8774-08d731543898"],
   institution: "FlinksCapital",
   step: "ACCOUNT_SELECTED"
}

🚧

Account details for selected accounts

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

Display All Accounts

To display accounts from all categories for selection, including the ones that are not eligible for transfers (ETF), use the parameter showAllAccounts=true.

Note that when this parameter is used, other operation accounts filters such as eftEligibleRatio and showAllOperationAccounts are ignored.

Multiple Selection

By default, only a single account can be selected. In order to enable multiple accounts to be selected, the parameter accountSelectorMultiple=true needs to be set.

When multiple accounts are selected,

Example of redirected URL when multiple accounts are selected:

https://flinks.com/contact/thank-you/?loginId=af9c2f59-461f-40cd-d383-08d731541b7b&accountId=7d213d26-d966-4229-8774-08d731543898,9290ca11-8352-4e88-8775-08d731543898&institution=FlinksCapital

Example of the JS event for new multiple accounts:

{
   accountId: ["7d213d26-d966-4229-8774-08d731543898", "9290ca11-8352-4e88-8775-08d731543898"],
   institution: "FlinksCapital",
   step: "ACCOUNT_SELECTED"
}

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.

Range of Transactions

ParameterDefault ValueValid Values
daysOfTransactionsDays90Days90, Days365
withTransactionstruetrue, 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=Days365. If you do not need to collect the transaction history, specify the parameter withTransactions=false.

Bank Issued PDF Statements

ParameterDefault Valuevalid values
detailsAndStatementEnablefalsetrue, false
monthsOfStatementsMostRecentMonths3, Months12

For setting a connection to additionally extract bank issued monthly PDF statements file, the parameter detailsAndStatementEnable=true is required. When enabled, by default only the last month statement is extracted, however up to 12 months of statements can be retrieved by using the parameter monthsOfStatements.

📘

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

ParameterDefault Valuevalid values
scheduleRefreshfalsetrue, 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

ParameterDefault Valuevalid values
tagnone-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.

MaximumRetry

ParameterDefault ValueValid Values
maximumRetry991 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.

Stringify

ParameterDefault ValueValid Values
stringifyfalsetrue, false

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

Version 1 Deprecated Parameters

theme
desktopLayout
fixedHeightEnable
containerFullScreen
boxLayout
Preset
containerFullScreen
containerNoPadding
institutionsFullLogo
institutionLayout
institutionsFullLogo
loadingType
customerNameCamelCase
backgroundColor
foregroundColor1
foregroundColor2


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.