Skip to main content
POST
Resolve or create the authenticated user's Free entitlement

Authorizations

Authorization
string
header
required

JWT authentication token

Body

application/json
device_fingerprint
string

Opaque privacy-conscious browser signal; only an HMAC is stored.

Maximum string length: 1024

Response

Free granted or already exists, or another entitlement already applies

status
enum<string>
required
Available options:
allowed,
existing,
challenge_required,
denied,
paid_or_team_entitled
accounting_mode
enum<string>
Available options:
free_usage,
self_serve_usage,
legacy_credits
code
string

Stable decision code, including free_device_already_claimed for a device that permanently consumed its Free grant.

turnstile_site_key
string