Generating a new requestId

All retrieval of data starts with new session being initiated. For that, you need to generate a new requestId with Flinks by calling /Authorize in cached more. It will return the last data aggregation done for that specific card.


Flinks Connect Integration

Flinks Connect is at the center of your Front End experience, it handles user banking authentication and MFA so you don't have to. Once completed successfully, Flinks Connect will return a loginId through the URL or the events. More details can be found [here] (https://docs.flinks.com/docs/connecting-accounts-widget).

In order to successfully retrieved cached data, you will need to specify the following parameters in your call to /Authorize :

  "LoginId": "{LoginId}",

When Flinks validates that the loginId belongs to the instance and that no errors occurred while pulling data, /Authorize will respond with a 200 HTTP status code.

    "Links": [
            "rel": "AccountsDetail",
            "href": "/GetAccountsDetail",
            "example": null
            "rel": "AccountsSummary",
            "href": "/GetAccountsSummary",
            "example": null
            "rel": "Statements",
            "href": "/GetStatements",
            "example": null
    "HttpStatusCode": 200,
    "Login": {
        "Username": "Greatday",
        "IsScheduledRefresh": false,
        "LastRefresh": "2020-04-15T22:46:03.1690585",
        "Type": "Personal",
        "Id": "b0debb48-f9f1-46c6-80a4-08d7dd88d478"
    "Institution": "FlinksCapital",
    "RequestId": "006fd2f3-055b-4ef6-a9fc-c1261cd76ec6"

Once this step is reached, it means that your session was successfully opened, and the received RequestId can be used to make calls to other data retrieval endpoints. (/GetAccountDetails, for example)

Keep in mind that the LastRefresh data point is in UTC.

LoginId definition

A specific LoginId will always be attached to the same Institution, Username and Language. It will be the same LoginId even if the password changes. It is also unique and specific to an instance.

For example, a LoginId for Sandbox will not exist in a private instance, even if they have the exact Institution, Username and Language.


Keep track of each new LoginId, for a later use, or even for a later deletion of data, since Flinks will retain data undefinitely unless [/DeleteCard](https://docs.flinks.com/reference/deletecard) is used.

Multi-Factor Authentication

If you receive a 203 response, the user must answer multi-factor authentication (MFA) question(s) as a final step in the authentication process.

When you receive this response, call the /Authorize endpoint a second time and pass the RequestId and SecurityResponses parameters.