Token

Refreshes an API authentication token using a valid refresh token.

Unique resource name: api_authentication.v1.refresh

This endpoint allows clients to obtain a new access token by providing a valid refresh token. The refresh token must be issued by the authentication service and must not be expired.

Authentication Process:

  • The refresh-token header must contain a valid refresh token.
  • If the refresh token is valid, a new access token is issued.
  • If the refresh token is invalid or expired, a 401 Unauthorized response is returned.

Security Considerations:

  • Refresh tokens should be stored securely and not shared.
get/api/v1.0/authentication/Refresh

Request

  • Base URL: https://sandbox.sparefinancial.sa
  • URL: https://sandbox.sparefinancial.sa/api/v1.0/authentication/Refresh
  • Auth: none declared. Required headers: refresh-token

Headers

refresh-tokenstring required

The refresh token used to obtain a new access token.

Response

Successfully generated a new API authentication token.

typestring nullable
access_tokenstring nullable
expires_ininteger
refresh_tokenstring nullable
refresh_expires_ininteger

Changes

No recorded changes to this operation across all 1 revision of this API.