Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.flinks.com/llms.txt

Use this file to discover all available pages before exploring further.

​
What your customers will see

The following widget is embedded into your site as an iframe. Choose from a variety of customization parameters to change the design of your screens to fit your brand experience. Click through the screens below and configure the first version of your Flinks Connect widget.
Flinks Connect is supported by the following browsers:
  • Chrome
  • Safari
  • Firefox
  • Opera
  • Microsoft Edge
The design and functionality of your Flinks Connect screens are controlled by parameters in the iframe URL. Enable (or disable) components by updating the parameters in the URL. Here’s an example:
html
https://toolbox-iframe.private.fin.ag/v2/?demo=true&redirectUrl=https://www.example.com/thank-you

​
Use the most recent version

The latest version of the Flinks Connect design is version t2. Enable this version by adding /v2/ to your iframe URL:
Url
https://toolbox-iframe.private.fin.ag/v2/

Already using version 1?

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

​
Pass an authorize token

Pass a valid authorize token every time you authenticate. If you are using Flinks Connect, this parameter must be included in your iframe URL.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
authorizeTokenstringfalse{string}

​
List of customization parameters

The following table lists all customizations you can make to your Flinks Connect widget. Click on each section for more information on adding it to your iframe URL.
CUSTOMIZATIONPARAMETER
Enable our dummy institution, Flinks Capital, for testing purposes in Flinks Connectdemo
Enable our dummy institution, Flinks Capital, for OAuth connections in OutbounddemoOutbound
Change the language on the screens to French or Englishlanguage
Set the color theme (light, dark, or follow the user’s OS preference)theme
Add or remove a “Close” button to allow the user to exit the widgetcloseEnable
Add or remove a “Back” button to allow the user to return to previous screensbackEnable
Add or remove the Flinks logo in the headerheaderImgEnable
Add or remove the header section, including the Flinks logo and all textheaderEnable
Add or remove a static loading pagestaticLoadingEnable
Add or remove paddingremovePadding
Add or remove the Consent screenconsentEnable
Customize the title on the Consent screenconsentTitleAppendedText
Add your logo to the Consent screenContact your Flinks Representative
Preselect specific financial institution(s) on the Login screenUse the institution ID or routing number

​
Enter demo mode for testing purposes

Show our dummy institution, Flinks Capital, as an available institution to select for testing purposes.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
demobooleanfalsetrue, false
To show Flinks Capital, include demo=true in your iframe URL:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?demo=true

​
Outbound (oAuth connections)

PARAMETERTYPEDEFAULT VALUEVALID VALUES
demoOutboundbooleanfalsetrue, false
To show Flinks Capital for oAuth connections, include demoOutbound=true in your iframe URL:

​
Change the language

Flinks Connect supports both English and French, but will display English on all screens by default. When you change the language, all screens, including multi-factor authentication (MFA), will display the new language. To switch all screens to French, use the language parameter.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
languagestringenen, fr
To use French on your Flinks Connect screens, add language=fr to the iframe URL:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?language=fr

​
Set the color theme

By default, Flinks Connect renders with a light theme. Use the theme parameter to switch to a dark theme or follow the end user’s OS preference. The setting applies to all widget screens — consent, institution selection, credentials, MFA, account selector, success, errors, upload, and bottom sheets.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
themestringlightlight, dark, system
  • light — standard light theme (identical to omitting the parameter).
  • dark — dark theme with inverted palettes and adjusted contrast.
  • system — follows the end user’s OS dark mode preference and switches in real time if it changes.
Institution-specific branding colors (such as bank logos) are preserved across all themes. For example, to render the widget in dark mode, add theme=dark to the iframe URL:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?theme=dark
To follow the end user’s OS preference:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?theme=system

​
Customize the page layout

This section lists the page elements you can choose to include in your Flinks Connect integration or forego.

​
Add or remove a ‘Close’ button

Use the closeEnable parameter to specify if you want to display a ‘Close’ button on your Flinks Connect screens. One is not included by default.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
closeEnablebooleanfalsetrue, false
For example, to display a ‘Close’ button, add closeEnable=true to your iframe URL:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?closeEnable=true

​
Add or remove a ‘Back’ button

Use the backEnable parameter to specify if you want to display a ‘Back’ button on your Flinks Connect screens. We include this by default, but it can be removed.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
backEnablebooleanfalsetrue, false
For example, to remove the ‘Back’ button from your Flinks Connect screens, add backEnable=false to your iframe URL:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?backEnable=false
Use the headerImgEnable parameter to specify if you want to display the Flinks logo on your Flinks Connect screens. We display it by default, but it can be removed.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
headerImgEnablebooleanfalsetrue, false
For example, to remove the Flinks logo, add headerImgEnable=false in your iframe URL:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?headerImgEnable=false

​
Add or remove the header section

Use the headerEnable parameter to specify if you want to include a header section on your Flinks Connect screens. By default, we display a header section with the Flinks logo and customizable text.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
headerEnablebooleanfalsetrue, false
For example, to remove the header section, add headerEnable=false to your iframe URL:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?headerEnable=false

​
Add or remove a static loading page

Use the staticLoadingEnable parameter to specify if you want to display a static loading page. We don’t include this by default, but you can choose to add it into your integration.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
staticLoadingEnablebooleanfalsetrue, false
For example, to display a static loading screen, add staticLoadingEnable=true to your iframe URL:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?staticLoadingEnable=true

​
Add or remove padding

Use the removePadding parameter to specify if you want to add or remove padding on your Flinks Connect screens. All screens have padding by default, but it can be removed.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
removePaddingbooleanfalsetrue, false
For example, to remove padding from the screens, add removePadding=true to your iframe URL:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?removePadding=true
Choose whether or not to display the Consent screen in your Flinks Connect integration and customize various elements on it. Use the consentEnable parameter to specify if you want to include a Consent screen in your Flinks Connect integration. This screen lists every type of data that the application needs access to, and requires the end-user to provide consent before sharing their financial data. This screen is included in your integration by default, but can be removed. It’s displayed after the user selects a financial institution but before the Login screen. When enabled, the Consent screen is the first screen that’s displayed to the user when the widget loads.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
consentEnablebooleantruetrue, false
For example, to disable the Consent screen, add consentEnable=false to your iframe URL:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?consentEnable=false
This is what your users will see if you choose to enable the Consent screen (collapsed view):
Screenshot of the collapsed view of the user consent screen in Flinks Connect
The Consent screen (expanded view): Screenshots of the expanded view(s) of the user consent screen in Flinks Connect By default the Consent screen has the following title: Screenshot of the default title on the user consent screen in Flinks Connect Use the consentTitleAppendedText parameter to change the title on the Consent Screen.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
consentTitleAppendedTextstringnone-set
By default, the Consent Screen displays the Flinks logo at the top of the page, but you can customize the screen by adding your own company logo as well. Here’s what it looks like: Screenshot of Flinks Connect configured to include a custom logo To add your logo to the Consent Screen in Flinks Connect, contact your Flinks Representative.

​
Customizing the Institution Login screen

This is how the Institution Login screen looks by default: Screenshot of the login page on Flinks Connect. The user is logging in to an account with the default institution, Flinks Capital

​
Preselect a specific financial institution

Set up your Flinks Connect integration so that it loads on the login page of a particular financial institution, skipping the Financial Institution Selection screen. There are two ways you can do this:
  • By institution ID
  • By routing number

​
Preselect by Institution ID

  1. Determine the ID of the financial institution you want to preselect using the /Institutions endpoint.
  2. Update your iframe URL with the following structure: https://[iframe-instance]/Credential/[Institution-ID]
For example, to load your Flinks Connect integration on Chase’s login page, add Credential/20 to your iframe URL:
Url Example
https://toolbox-us-iframe.private.fin.ag/v2/Credential/20

​
Preselect by routing number

This option is only available for certain US financial institutions. For a full list of available routing numbers, call the Institutions API.
  1. If the financial institution you want to preselect is US-based, determine if the routing number is supported by calling the /Institutions endpoint.
  2. Update your iframe URL with the following structure:
    Url
      https://[iframe-instance]/Credential/[routing-number]/?[parameters]&routingNumber=true
For example, to load your Flinks Connect integration on Chase’s login page, add their routing number (071000770) to your iframe URL:
Url Example
https://toolbox-us-iframe.private.fin.ag/v2/Credential/071000770?routingNumber=true

Only available for certain US financial institutions

If the routing number is not associated with a financial institution in our system, an error message will display to the user, and they’ll be redirected back to the Financial Institution Selection screen.

​
Add or remove term and conditions

​
Terms and conditions

PARAMETERTYPEDEFAULT VALUEVALID VALUES
termsUrlstringnone-set{string}
termsNoCheckboxbooleanfalsetrue, false
customerNamestringnone-set{string}
termsTextPreLinkstringnone-set{string}
termsTextLinkstringnone-set{string}
termsTextPostLinkstringnone-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.
  • termsTextPreLink: text displayed in the terms and conditions before the link.
  • termsTextLink: text displayed in the terms and conditions link.
  • termsTextPostLink: text displayed in the terms and conditions after the link.
Screenshot of the login page on Flinks Connect. The user is logging in to an account with the default institution, Flinks Capital

​
Enhanced Multi-factor Authentication (Deprecated)

PARAMETERTYPEDEFAULT VALUEVALID VALUES
enhancedMFAbooleanfalsetrue, false
skipEnhancedMFAbooleanfalsetrue, false
withMFAQuestionsbooleanfalsetrue, false

These parameters are deprecated

Enhanced MFA is no longer an actively supported feature. Most Canadian financial institutions have moved to one-time passwords and push notifications, which cannot be answered automatically. Do not use these parameters in new integrations.For refreshing account data, implement a user-initiated reconnection flow instead. See the Reconnect guide for more details.

​
Redirect (mandatory for OAuth connectivity)

PARAMETERTYPEDEFAULT VALUEVALID VALUES
redirectURLstringnot-set{string URL} (ex: https://www.example.com/thank-you)
innerRedirectbooleanfalsetrue, false
jsRedirectbooleanfalsetrue, false
Flinks Connect will redirect the end user to a landing page once their account is successfully connected. We recommend setting 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 your landing page URL must be encoded.

RedirectURL whitelisting

As an added layer of security, Flinks requires that the domain name used in the redirectURL parameter be shared with us so we can whitelist it. Failure to share this information could prevent Flinks Connect to load entirely and result in displaying the following message:The iframe URL will also update to the following:https://instance-iframe.private.fin.ag/v2/Error?validRedirectUrl=false

Parameters in your Redirect URL

You must encode all parameters that are specific to your landing page URL.✔️ Good usage: redirectUrl=https%3A%2F%2example.com%2F%3FurlEncoded%3Dtrue❌ Bad usage: redirectUrl=https://example.com/?urlEncoded=true
If the parameter redirectUrl is not specified, a generic thank you page will be displayed.

​
Account Selection

PARAMETERTYPEDEFAULT VALUEVALID VALUES
accountSelectorEnablebooleanfalsetrue, false
accountSelectorMultiplebooleanfalsetrue, false
fetchAllAccountsbooleanfalsetrue, false
accountSelectorNoTitlebooleanfalsetrue, false
eftEligibleRationumber0.80.0 to 1.0
showAllOperationsAccountsbooleanfalsetrue, false
accountSelectorCurrencystringcad, usdcad, 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. Screenshot of the Flinks Connect UI. The user is asked to select between two of their BMO accounts In the case where 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 before your iframe. Example of the redirected URL when the Account Selector is enabled:
Shell
https://example.com/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:
Json
{
  "accountId": ["7d213d26-d966-4229-8774-08d731543898"],
  "institution": "FlinksCapital",
  "step": "ACCOUNT_SELECTED"
}

Accounts details for selected accounts

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

​
Display all account

To display accounts from all categories for selection, including the ones that are not eligible for transfers (EFT), 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. Example of a redirected URL when multiple accounts are selected:
Shell
https://example.com/thank-you/?loginId=af9c2f59-461f-40cd-d383-08d731541b7b&accountId=7d213d26-d966-4229-8774-08d731543898,9290ca11-8352-4e88-8775-08d731543898&institution=FlinksCapital
Example of a JS event for new multiple accounts:
Json
{
  "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

PARAMETERTYPEDEFAULT VALUEVALID VALUES
daysOfTransactionsstringDays90Days90, Days365
withTransactionsbooleantruetrue, false
By default, Flinks Connect extracts Transactions history data for the last 90 days. It is possible to increase the 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

PARAMETERTYPEDEFAULT VALUEVALID VALUES
detailsAndStatementEnablebooleanfalsetrue, false
monthsOfStatementsstringMonths3MostRecent, Months3, Months12
For setting a connection to additionally extract bank-issued monthly PDF statements file, the parameter detailsAndStatementEnable=true is required. When enabled by default, the last 3 months of statements will be 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 (Deprecated)

PARAMETERTYPEDEFAULT VALUEVALID VALUES
scheduleRefreshbooleanfalsetrue, false

Nightly Refresh is no longer actively supported

Automatic nightly refresh is no longer supported for most financial institutions. Do not use scheduleRefresh in new integrations. To refresh account data, the end-user must be present and complete a live connection through Flinks Connect. See the Nightly Refreshes (Deprecated) page for details and alternatives.

​
Tag

PARAMETERTYPEDEFAULT VALUEVALID VALUES
tagstringnone-setstring
Custom tags let you attach your own reference data to a connection request so you can reconcile Flinks loginIds with records on your side — for example, an internal user ID, a campaign name, or a workflow reference.

Never include personal information (PII) in tags

Tag values are passed through URLs, logs, and webhook payloads. They are not a secure channel. Do not include any PII, such as:
  • Email addresses
  • Phone numbers
  • Full names
  • Dates of birth
  • Government IDs (SIN, SSN, driver’s license, etc.)
  • Physical or mailing addresses
Use an opaque identifier (e.g., your own userId as a GUID) that maps back to PII inside your own systems.
To set a tag, pass the tag parameter in your Flinks Connect iframe URL:
Url Example
https://toolbox-iframe.private.fin.ag/v2/?tag=userId=8b35f6c8-e7b6-41d3-98f8-08d68b7f8d31

​
MaximumRetry

PARAMETERTYPEDEFAULT VALUEVALID VALUES
maximumRetryinteger991–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

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

​
Inputs

PARAMETERTYPEDEFAULT VALUEVALID VALUES
preventAutoFocusbooleanfalsetrue, false
preventAutoFillbooleanfalsetrue, false
By default, Flinks Connect allows auto-complete functionality on input fields. As well, Flinks Connect will automatically focus input fields that require user action. If either of these behaviours causes issues in your app, they can be disabled by using preventAutoFocus=true and preventAutoFill=true.

​
Webview

PARAMETERTYPEDEFAULT VALUEVALID VALUES
webviewbooleanfalsetrue, false
When set to true, Flinks Connect emits events through window.ReactNativeWebView.postMessage instead of window.postMessage. Use this parameter when loading Flinks Connect inside a native mobile WebView (iOS, Android, or React Native). For detailed setup instructions, see Mobile Integration.

​
Institution filter

PARAMETERTYPEDEFAULT VALUEVALID VALUES
institutionFilterEnablebooleanfalsetrue, false
When enabled, displays a search/filter bar on the institution selection screen, allowing users to quickly find their financial institution by name. This is recommended when your integration supports a large number of institutions. Flinks Upload is a feature that you can enable in Flinks Connect to process and extract data from a bank statement or void cheque. By default, Flinks Connect displays a title and subtitle on the upload screen:
Screenshot of the Flinks Connect UI. The user is asked to upload bank statements for the dummy institution, Flinks Capital.
To customize the text on this screen, use the following parameters:
PARAMETERTYPEDEFAULT VALUEVALID VALUES
fileUploadTitlestringnone-set{string}
fileUploadSubtitlestringnone-set{string}
For more information about the types of files you can upload and what this feature supports, see What can I upload?.

This feature must be switched on

To start using Flinks Upload, contact your Flinks Representative, and we will enable it for you.

​
Enable full page redirects

This parameter is useful if you’re loading Flinks Connect as the top-level window (or in web view) and are noticing that the iframe is blocking pop-ups. Use the oauthWindowRedirect=true parameter to enable a full page redirect rather than relying on pop-up behaviour. If Flinks Connect is loading inside an iframe, passing this parameter will not work.
PARAMETERTYPEDEFAULT VALUEVALID VALUES
oauthWindowRedirectbooleanfalsetrue, false