Skip to main content
The Simply Tokenized API uses date-based versioning (similar to Stripe). Each version represents a contract for request and response shapes.

​
Current version

2026-07-02 is the only supported version today. It is marked beta because the API is still evolving. Breaking changes may occur before a stable release. Use the development base URL when testing this version.
Use the version switcher in the top navigation of these docs to browse documentation for a specific contract date. The switcher shows a Beta badge for 2026-07-02.

​
Environment base URLs

Beta API versions are available on development. Live will receive stable versions when they are released.

​
How version is chosen

When you call POST /api/auth, the API version is resolved in this order:
  1. api_version in the auth request body (if provided)
  2. Default version on the API credential
  3. Recommended version (2026-07-02)
The resolved version is:
  • Embedded in the JWT as the api_version claim
  • Returned in the ST-Api-Version response header on every API response
  • Marked as beta via ST-Api-Version-Beta: true for 2026-07-02 (development)

​
Beta indicator header

Responses for beta version 2026-07-02 on development include:
Integrators can use this header to detect beta contract versions programmatically.

​
Version format

Versions must match YYYY-MM-DD and be listed in the supported versions set. Requesting an unsupported version returns:

​
Protected endpoints

Protected routes use the version from the JWT, not from a request header. You cannot change the contract mid-session — obtain a new token with a different api_version at auth time.

​
Adding new versions

When a new API version is released:
  1. A new entry appears in the docs version switcher (with Stable or Beta tag as appropriate)
  2. Existing integrations on older versions continue to work until deprecated

​
Stable releases

When 2026-07-02 graduates from beta to stable, the ST-Api-Version-Beta header will no longer be sent for that version. Stable versions will roll out to the live environment.