Refresh a JWT token, resulting in a new JWT token to be used by subsequent requests.

POST

/api/v1/refresh

Request Body ^required

object

refreshToken

Refresh token.

string

Example

ab6f6e74935129101a04882fb39be0c0440f9d4df271fa7654a0f99f847b9e0871db61bb515cb8ef5c11f7c298551f9a59107ec0ffb34f06eeab9f99272385cd

Responses

200

Token refreshed.

object

token

Authentication token. Use this to request resources requiring authentication.

string format: string

Example

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

refreshToken

Refresh token. Use this to request a new authentication token.

string format: string

Example

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

400

A list of possible errors for this endpoint.

object

code

required

string

Allowed values: ER036 ER037 ER999

message

required

string

solution

required

string

Example

{
  "errors": {
    "ER036": {
      "code": "ER036",
      "message": "Refresh token is invalid or expired.",
      "solution": "Provide a valid refresh token or request a new (regular) token."
    },
    "ER037": {
      "code": "ER037",
      "message": "Refresh token is invalid.",
      "solution": "Provide a valid refresh token."
    },
    "ER999": {
      "code": "ER999",
      "message": "A general error has occurred. Please contact our support team.",
      "solution": "Contact our support team."
    }
  }
}