auth

Authenticate an application using its API key credentials.

Validates the application identifier and API key, enforces IP whitelist policy, verifies application and client status, and issues a signed JWT with role-derived audience scopes.

POST /auth/api-keys/sessions

post/auth/api-keys/sessions

Request

  • Base URL: https://api.sandbox.tryspare.ae
  • URL: https://api.sandbox.tryspare.ae/auth/api-keys/sessions
  • Auth: none declared. Required headers: x-tenant, app-id, x-api-key

Headers

x-tenantstring required
Example:UAE

Regulatory jurisdiction the request routes to (e.g. UAE, KSA, MAIN). Match it to the market you're integrating.

app-idstring required

Your application's App ID, from the developer dashboard.

x-api-keystring required

Your application's API key, from the developer dashboard.

Response

Success response

access_tokenstring required

Bearer access token for subsequent API requests.

expires_innumber required

Access token lifetime in seconds.

refresh_expires_innumber required

Refresh token lifetime in seconds.

refresh_tokenstring required

Refresh token for renewing the session.

type'Bearer' required

Variant selector, determines which other fields are required.

Example response

{
  "type": "Bearer"
}

Changes

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