Skip to main content
GET
/
v3
/
oauth
/
authorize
OAuth Authorize
curl --request GET \
  --url https://{instance}-api.private.fin.ag/v3/oauth/authorize \
  --header 'Accept: <accept>'
"<html>\n<head>\n  <title>Submit Form</title>\n  <meta name=\"referrer\" content=\"origin\" />\n  <meta http-equiv=\"x-ua-compatible\" content=\"IE=edge\" />\n</head>\n<body onload=\"javascript:document.forms[0].submit()\">\n  <noscript>\n    <p>\n      <strong>Note:</strong> Since your browser does not support JavaScript, you must press the Resume button once to proceed.\n    </p>\n  </noscript>\n  <form method=\"post\" action=\"https://ob.flinksapp.com/api/v1/agentless\">\n    <input type=\"hidden\" name=\"REF\" value=\"613D213BC21A4480DBC844AABC852EFDB129387225AE7317A77B7A56400C\"/>\n    <input type=\"hidden\" name=\"allowInteraction\" value=\"true\"/>\n    <input type=\"hidden\" name=\"scope\" value=\"ACCOUNT_BASIC ACCOUNT_DETAILED ACCOUNT_PAYMENTS INVESTMENTS TRANSACTIONS STATEMENTS CUSTOMER_CONTACT CUSTOMER_PERSONAL\"/>\n    <input type=\"hidden\" name=\"provider_id\" value=\"4003\"/>\n    <input type=\"hidden\" name=\"response_type\" value=\"code\"/>\n    <input type=\"hidden\" name=\"connectionId\" value=\"dc-patrfyrs91n711c9jlmtsru97\"/>\n    <input type=\"hidden\" name=\"redirect_uri\" value=\"https://toolbox-api.private.fin.ag/v3/43387ca6-0391-4c82-857d-70d95f087ecb/openbanking/callback\"/>\n    <input type=\"hidden\" name=\"state\" value=\"jc1LCoAwDADRu2Rtjdag4G1i2qJYP7QBFfHuegT385gbJuiha9vKSk3GO7KGXNcYdhSMdQ1XQrUEClBA+tJRdc894s7XMem4XAOvcynbglk5KfpTfVo5onCMA8v8ufx38bw=\"/>\n    <input type=\"hidden\" name=\"resumePath\" value=\"/as/1PT1G/resume/as/authorization.ping\"/>\n    <input type=\"hidden\" name=\"lang\" value=\"en\"/>\n    <input type=\"hidden\" name=\"client_id\" value=\"dc-patrfyrs91n711c9jlmtsru97\"/>\n    <input type=\"hidden\" name=\"reauth\" value=\"false\"/>\n    <noscript><input type=\"submit\" value=\"Resume\"/></noscript>\n  </form>\n</body>\n</html>\n"
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. This endpoint responds with a redirect. Once the API returns a 302, you can grab the URL from the Header -> Location field and present the end user with the financial institution’s login page.

Headers

Accept
string
default:text/plain
required

Acceptable response media type.

Query Parameters

institution_id
string

The end-user's financial institution.

redirect_uri
string

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

state
string

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.

lang
string
default:en

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.

tag
string

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

recipientId
string

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

Response

Redirect Response

The response is of type string.