Sign in

v1

latestOpenAPI 3.0.32026-07-13347237.5 KB
Authorization

Authorize

post/v3/{customerId}/BankingServices/Authorize

Path parameters

customerIdstring required
Example:43387ca6-0391-4c82-857d-70d95f087ecb

Unique GUID provided by Flinks that grants you access to the environment specified in the instance field. By default, the value is the key for the toolbox environment.

Headers

flinks-auth-keystring required
Example:d65f1adb-8ebc-48dc-be8b-20c773ba1565

Authorize token (one-time, 15-minute lifetime) generated by /GenerateAuthorizeToken. Do not pass your secret key here. The secret key is only used when generating the token.

Content-Typestring
Example:application/json

Content type of the request.

Acceptstring
Example:application/json

Acceptable response media type.

Request body

LoginIdstring

Identifier returned by Flinks Connect after a successful customer authentication. Use this in combination with MostRecentCached: true to open a session against the cached data aggregated by the widget. This is the recommended flow for most integrations.

MostRecentCachedboolean

Controls how the session is opened. true = cached mode (recommended): pair with LoginId to retrieve the most recently aggregated data for a customer. false = live mode: initiates a fresh live connection to the financial institution; typically used for manual refresh or direct API (legacy) integrations with Username/Password.

Usernamestring

Username used to connect to the financial institution. Only used for direct API (legacy) integrations when MostRecentCached is false. Flinks Connect handles authentication for the widget integration path.

Passwordstring

Password used to connect to the financial institution. Only used for direct API (legacy) integrations when MostRecentCached is false.

Institutionstring

Unique identifier of the financial institution. Only required for direct API (legacy) integrations. The widget sets this automatically.

Languagestring

Preferred language for the connection process (en | fr)

Saveboolean

If set to true, all collected data and credentials will be saved after the request is completed.

Tagstring

Custom string to attach to a specific request.

RequestIdstring uuid

Required for MFA. Pass the RequestId received in the 203 response.

SecurityResponsesobject

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, where keys are the prompts and values are arrays of answers.

Example request

{
  "LoginId": "5e115eac-1209-4f19-641c-08d6d484e2fe",
  "MostRecentCached": true
}

Response

Authorization successful - Session opened and RequestId can be used for subsequent data calls

HttpStatusCodeinteger

HTTP status code

InstitutionNamestring

Name of the financial institution

InstitutionIdinteger

Unique identifier of the financial institution

Institutionstring

Name of the financial institution

RequestIdstring uuid

Unique request identifier used for subsequent data calls

Example response

{
  "HttpStatusCode": 200,
  "Links": [
    {
      "rel": "AccountsDetail",
      "href": "/GetAccountsDetail",
      "example": null
    },
    {
      "rel": "AccountsSummary",
      "href": "/GetAccountsSummary",
      "example": null
    },
    {
      "rel": "Statements",
      "href": "/GetStatements",
      "example": null
    }
  ],
  "InstitutionName": "FlinksCapital",
  "Login": {
    "Id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "Username": "greatday",
    "LastRefresh": "2026-01-21T20:47:47.145999",
    "Type": "Personal"
  },
  "InstitutionId": 14,
  "Institution": "FlinksCapital",
  "RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}