Skip to main content

​
Choose a product

The first step to connecting your customer accounts is choosing a front-end solution. The front-end solution is the interface that your customers use to link their banking data. Flinks provides three front-end configuration options: To learn more about the capabilities and requirements for each option, refer to the table below and the following sections.
FLINKS PRODUCTCONNECTS CUSTOMER ACCOUNTSCUSTOMIZABLE FOR YOUR BRANDEMBEDDED IN YOUR SITECODING WORK REQUIRED
Flinks Connect
Flinks Express
Custom

​
Complete the general integration steps

Complete the following to set up your product:
  1. Set up your environments.
  2. Connect to our APIs.
  3. Complete your product-specific integration steps (you can find these in the following section).
  4. Access your Flinks Dashboard.
  5. Complete testing.

​
Set up your Connect product

Complete one of the following sections to set up your Connect product: At a high level, the following steps are required to set up Flinks Connect:
  1. Configure and install Flinks Connect.
  2. Complete the general integration steps.
  3. Set up the iframe URL parameters.
  4. Set up your website or app to allow pop-ups to open.
  5. Use the redirectURI parameter to allow Flinks to bring the end user back to your page after completing the authorization flow.
  6. (Optionally) Set up an event listener to keep track of each user’s events in the iframe. To do this, place the following script on the page:
    Html
    <!-- Event Listener -->
<script>
  window.addEventListener("message", function (e) {
    console.log(e.data);
  });
</script>
  7. After the end user successfully connects their account, Flinks Connect provides a loginId that allows you to access the data connected for that particular user through our APIs. Save the loginId by securely storing it in your servers. Do not make a loginId public.
  8. (Optionally) If your use-case requires it, Flinks provides the /DeleteCard endpoint that allows you to delete the loginId and end all user data that’s associated with it.
  9. Set up the back-end solution.
  10. (Optionally) Choose data enrichment add-ons to collect powerful insights on the customer data.
  11. Securely receive the customer’s data by using the requestId.
Flinks Express is the fastest way to integrate with us to connect end-user accounts. It’s a hosted solution that we manage on your behalf, but design it to look like your website. At a high level, the following steps are required to set up Flinks Express:
  1. Complete this form to let us know you want to customize your Flinks Express configuration.
  2. Contact your Flinks Representative to let them know when you have submitted the form.
  3. Flinks uses the customizations you’ve requested to build your Flinks Express instance, then provides you with the link to it.
  4. Review your completed Flinks Express configuration.

​
Set up a custom API integration

Custom integrations only

This section explains how to set up custom integrations that use a direct API connection. If you are using Flinks Connect, this section does not apply to you.
Complete the following steps to connect with us using a custom API integration that uses OAuth 2.0.
  1. Ask your Flinks Representative to whitelist the URLs that your endpoints will be calling, including the redirect URL in step 2ii.
  2. Call the /OAuth/Authorize endpoint and perform the following tasks:
    • Redirect the end-user to their bank’s login screen using the institution parameter. Here, they’ll enter their login credentials and complete multi-factor authentication (MFA) if required.
    • Provide a URL to direct the end-user’s screen back to your website or app using the redirect_uri field. If the login is successful, you’ll receive a redirect response that contains the redirect URL, a loginId:
    Json
    https://{redirect}?loginId={loginId}&state={state}
    • If unsuccessful, you’ll receive a redirect response that contains a redirect URL and an error message:
    Json
    https://{redirect}?state={state}&error={error}&error_description={error_description}
  3. Call the /Authorize endpoint and apply the following settings to initiate the authorization flow:
    • Pass the loginId that you received in step 2.
    • Make the call in live mode by setting the MostRecentCached parameter to FALSE.
    • Set the save parameter to TRUE to maintain communication with the database (to do nightly refreshes, receive insights and more).
  4. If you receive a 200 response, the end-user is successfully authenticated, and you can now use Flinks APIs to retrieve data.