v1

latestOpenAPI 3.0.32026-07-13347237.5 KB

Authorization

OAuth Authorize

Use the /OAuth/Authorize endpoint if you are using a custom API integration and want to establish a secure connection using OAuth 2.0 technology.

get/v3/oauth/authorize

Query parameters

institution_idstring

The end-user's financial institution.

redirect_uristring

URL that redirects the end-user back to your app or website after completing the OAuth flow.

statestring

A unique string that you can randomly generate and link to this request to establish legitimacy. For the request to be successful, this string must be validated to confirm it's being passed with the correct request. The value of this field can be anything you want. This is an OAuth 2.0 standard and adds an extra layer of security.

langstring

Two-character abbreviation that specifies the language. Possible values include: - en = English - fr = French If this field is left empty, the default value is set to en.

tagstring

Custom name that's assigned to the request for identification and tracking purposes.

recipientIdstring

Specifies the Data Recipient who receives the data, only if the instance is associated with multiple Data Recipients.

Headers

Acceptstring required

Acceptable response media type.