Skip to main content

Token format

Issued API keys follow a structured v1 format:

{prefix}_v1_{identifier}_{checksum}

Components

PartLengthDescription
Prefix1-8 charsConfigurable label (e.g., prod, dev)
v12 charsFormat version
Identifier~32 charsBase58-encoded timestamp + UUID
Checksum10-11 charsHMAC-SHA256, truncated, Base58

How it works

The identifier contains a Unix timestamp and UUID v4, Base58-encoded. The UUID is the key_id used for database lookup. The checksum is HMAC-SHA256 over the payload, enabling tamper detection.

During verification, all configured secrets (current + retired) are tried, supporting zero-downtime secret rotation.

See Token format reference for the full specification.