Hanzo
OpenapiLicensing

Verify checks a license token online: signature, schema, expiry, app_id and the…

Verify checks a license token online: signature, schema, expiry, app_id and the revocation list.

POST /v1/licensing/verify

Addresshttps://api.hanzo.ai/v1/licensing/verify
MethodPOST
Operationpost_licensing_verify
AuthAuthorization: Bearer $HANZO_API_KEY

Verify checks a license token online: signature, schema, expiry, app_id and the revocation list.

It is UNAUTHENTICATED and always answers 200 — a bad token is valid:false with a reason rather than an error status, because "is this token good" is a question anyone may ask about a credential they already hold and the answer is the same either way. It is also OPTIONAL: the engine verifies OFFLINE against the published public key (GET /v1/licensing/pubkey) and needs this endpoint only to learn about revocation, so an outage here never stops a paid customer working.

Request

2 fields, body application/json (required).

FieldInTypeRequiredDescription
appbodystringApp overrides the app_id the token is expected to carry.
tokenbodystringyesToken is the license token to check.

Response

StatusBodyMeaning
200licensing.VerifyResponseok

200 body — 9 fields.

FieldInTypeAlwaysDescription
app_idbodystringAppID is the brand the token runs under.
expbodyintegerExp is the token's expiry, Unix seconds.
featuresbodystring[]Features are the capability grants the token carries.
fingerprint_boundbodybooleanBound reports that the token carries a device binding.
holderbodystringHolder is who the token was issued to.
noncebodystringNonce uniquely identifies the token.
reasonbodystringReason says why an invalid token was rejected.
revokedbodybooleanRevoked reports that the signature was good but the token has been revoked.
validbodybooleanValid is the single answer: signature, schema, expiry, app and revocation all passed.

Failure carries the platform error shape — see Errors.

Examples

hanzo licensing verify --token <token>

Licensing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page