/Authorize

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 mode. 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}", "MostRecentCached":true }'

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.

Path Params
string
required
Defaults to toolbox

Name of the environment used (Sandbox as default)

string
required
Defaults to 43387ca6-0391-4c82-857d-70d95f087ecb

The instance key (Sandbox key as default)

Body Params
boolean
Defaults to false

Specifies if you are calling the /Authorize endpoint in cached mode. Possible values include:

- TRUE = Calling /Authorize in cached mode
- FALSE = Calling /Authorize in live mode

If this field is left empty, the default value is FALSE.

boolean
Defaults to false

If set to true, all collected data and credentials will be saved after the request is completed. Set to false if not specified.

string

Connected account's Access Token.

string

Custom string to attach to a specific request.

string

Pass this parameter if you received a 203 response from the /Authorize endpoint and are calling it a second time to complete MFA questions.

This contains a valid Authorize Token and represents a successful first call to the /Authorize endpoint.

string

Pass this parameter if you received a 203 response from the /Authorize endpoint and are calling it a second time to complete MFA questions.

This parameter contains the user's responses to the MFA questions.

Headers
string
Responses

Language
URL
Request
Choose an example:
application/json