v1

latestOpenAPI 3.0.02026-07-2418630310.7 KB
Sync Authentication

Access Token & Refresh Token

Perform a POST request to /oauth/token with parameters client_id, client_secret, code, redirect_uri and grant_type=authorization_code. After following these steps, you will have an access token and a refresh token. The access token is valid for 2 hours, while the refresh token currently remains valid for 60 days.<br> <br> With the refresh token, you can request a new access token / refresh token pair: Perform a POST request to /oauth/token with parameters: client_id, client_secret, refresh_token, redirect_uri and grant_type=refresh_token. Each refresh token can be used only once. As soon as the new access token is used to access the API for the first time, the previous refresh token will be revoked.

post/f/{firm_id}/oauth/token

Path parameters

firm_idstring required

Query parameters

client_idstring required

required for both access token and refresh request

client_secretstring required

required for both access token and refresh request

grant_type'authorization_code' | 'refresh_token' required

set 'authorization_code' for initial request or 'refresh_token' for refresh request

codestring

provide authorization_code for initial access token request

redirect_uristring required

required for both access token and refresh request

refresh_tokenstring

provide refresh_token for refresh request

Response

Successful response

All 186 operations