Skip to content
the Platform
Sign in

Licence validation API

Validate a buyer's licence key. A key is valid only while the buyer's access is active.

Endpoint

POST /api/licence/validate

Request

  • key (string, required)
  • productId (string, optional) — restrict to a product
  • activate (boolean, optional) — consume one activation

Response

{ "valid": true, "productId": "...", "activationsRemaining": 2 }

When invalid, valid is false with a reason such as not_found, revoked, unassigned, inactive_entitlement or activation_limit_reached.

Example

curl -X POST /api/licence/validate \
  -H 'Content-Type: application/json' \
  -d '{"key":"ABCD-EFGH-JKLM-NPQR","activate":true}'

Full reference: docs/licence-api.md in the repository.