Claim a client token
Exchange a claim token for the IDs it refers to. Available only to developers using a k-ID SDK.
Authorization
api-key In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/client/claim" \ -H "Content-Type: application/json" \ -d '{ "claimToken": "kclm_9f2c4e7a1b3d5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8" }'{ "type": "session", "status": "PASS", "sessionId": "b1a6482d-5242-4b4a-aa88-3fa52595a672"}{ "error": "CLAIM_TOKEN_INVALID", "errorMessage": "Claim token is invalid or expired"}Get default permissions GET
Returns the permissions a player would receive by default in their jurisdiction, before any guardian consent. Supply the jurisdiction with at most one of `dateOfBirth`, `age`, or `kuid`; passing more than one is a bad request. With none, the player is treated as being of the current date's age. Nothing is persisted, so this is the endpoint for previewing what a jurisdiction permits before running an age gate.
Delete session POST
Deletes a player session by its session ID. The session must belong to the calling product. By default this is a soft delete: the session is marked revoked, is no longer queryable, and its player ID becomes reusable, but the record itself is retained. **Irreversible.** Setting `hardDelete` to `true` instead permanently deletes the session and its embedded consent — this cannot be undone. Available only to developers explicitly enabled for hard delete. A delete here sends a `Session.Delete` webhook with a `revocation` of `actor: developer` and `reason: deleted-by-developer`, or `erased-by-developer` for a hard delete. Treat every `Session.Delete` as "no session", and accept actors and reasons you don't know.