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!

Accounts Aggregation

Use-case Overview

Simplify everyone’s life with financial transparency.
Most people’s financial information is scattered across multiple institutions, which makes it difficult to provide a holistic, let alone a real-time understanding of their finances.

With Flinks, you can now enable your users to see the full picture of their finances in one place. Aggregation can allow you to consolidate information from their checking and savings accounts, as well as retirement plans, investments, credit cards, mortgages and other financial products they might have.

In seconds, your users can authorize a secure connection to their banks and share their relevant financial data with your application. This is delivered in a format that conveniently fits with your business processes, so you can provide immediate value back to the end-users.

Provide comprehensive financial profiles facilitate wealth management, or solve countless other problems with a personalized experience that helps your users set and achieve their goals.

Enabling with Flinks Tools

→ Conduct account verification and organize data:

  • Account title;
  • Account number;
  • Category and type;

→ Help users understand their net worth:

  • Available account balance

→ Categorize and display spending:

  • Transactions history up to the last 12 months

Listing Accounts

While aggregating different accounts, the first thing your user sees is the list of their connected accounts. The information you want to show in this list can be found under each item on the Accounts list:

"Accounts": [
        {
            "Transactions": [...],
            "TransitNumber": "77777",
            "InstitutionNumber": "777",
            "OverdraftLimit": 0,
            "Title": "Chequing CAD",
            "AccountNumber": "1111000",
            "Balance": {
                "Available": null,
                "Current": 49993.96,
                "Limit": null
            },
            "Category": "Operations",
            "Type": "Chequing",
            "Currency": "CAD",
            "Holder": {...},
            "Id": "ae1dac72-70da-4626-fed8-08d682e1ff4a"
        }
]

We can highlight in the summary:

  • Title;
  • Balance;
  • Category and Type;
  • Currency;

Account Information — Voided Cheque Information

To perform an EFT, you need all the elements of information that you would find on a voided cheque. With the selected tools from Flinks, you will already have it in hands without the need of a voided cheque.

To successfully complete a money transfer, you will need AccountNumber, TransitNumber and InstitutionNumber. These info information can be found here, under each account item:

"Accounts": [
        {
            "Transactions": [...],
            "TransitNumber": "77777",
            "InstitutionNumber": "777",
            "OverdraftLimit": 0,
            "Title": "Chequing CAD",
            "AccountNumber": "1111000",
            "Balance": {...},
            "Category": "Operations",
            "Type": "Chequing",
            "Currency": "CAD",
            "Holder": {...},
            "Id": "ae1dac72-70da-4626-fed8-08d682e1ff4a"
        }
]

Transaction History — Categorize and Display Spend

Flinks can collect up to a year of transaction history from your users' accounts. Each transaction information will contain the posted Date, Description, Debit or Credit value depending wether if it was a purchase or a deposit, and the current Balance when the transaction was posted.

Here's the structure of a transaction:

{
	"Date": "2019-04-20",
	"Code": null,
	"Description": "Starbucks Coffee",
	"Debit": 12.06,
	"Credit": null,
	"Balance": 4993.97,
	"Id": "1adfde25-832f-4acb-a683-4163bcb4182a"
}

Identity Information - Conduct identity verification

The personal information you receive from Flinks API is the same that's registered in the financial institution's side.

All personal information related will be contained inside Holder:

"Holder": {
	"Name": "John Doe",
	"Address": {
		"CivicAddress": "1275 avenue des Canadiens-de-Montréal",
    "City": "Montréal",
    "Province": "QC",
    "PostalCode": "H3B 5E8",
    "POBox": null,
    "Country": "CA"
	},
	"Email": "johndoe@flinks.io",
	"PhoneNumber": "(514) 333-7777"
}

What's Next

Ready to test Flinks by yourself? Start your integration!

Start your Integration
About Flinks

Accounts Aggregation


Suggested Edits are limited on API Reference Pages

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