Refresh Token

This endpoint is used to refresh an access token using a valid refresh token. It ensures that the App does not need to re-authenticate frequently.

Provides the refresh token that was issued along with the access token. The body of the request should include:

Request Body

ParameterData TypeField ValidationsDescription
refreshTokenStringMandatoryA unique string used to obtain a new access token after the current access token expires.

If the refreshToken is valid, you will receive both a new jwtToken and a new refreshToken.


Example Response

{
  "appId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "appName": "InvoiceApp",
  "accountId": "acc12345",
  "accountName": "MainAccount",
  "username": "user2024",
  "jwtToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IlVzZXIyMDI0IiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "jwtTokenExpireAtUTC": "2024-09-15T12:28:18.789Z",
  "refreshToken": "def45678",
  "refreshTokenExpireAtUTC": "2024-09-15T12:28:18.789Z"
}

Response Body

ParameterData TypeDescription
jwtTokenStringThe JWT (JSON Web Token) used for maintaining the authenticated session.
jwtTokenExpireAtUTCStringThe expiration time of the JWT token, represented in UTC.
refreshTokenStringA token used to renew the JWT upon expiry without requiring the user to re-authenticate. This field.
refreshTokenExpireAtUTCStringThe expiration time of the refresh token, represented in UTC. Similar to the jwtTokenExpireAtUTC, this indicates when the refresh token will no longer be valid.
Language
Click Try It! to start a request and see the response here!