Delete session
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.
Authorization
api-key In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/session/delete" \ -H "Content-Type: application/json" \ -d '{ "sessionId": "b1a6482d-5242-4b4a-aa88-3fa52595a672" }'{ "error": "NOT_FOUND", "errorMessage": "Session not found"}Claim a client token POST
Exchange a claim token for the IDs it refers to. Available only to developers using a k-ID SDK.
Get session GET
Returns a previously created session, identified by `sessionId` or by `kuid` together with the product. Pass `etag` to make the read conditional: the session is returned only if it changed since the etag was issued, and an unchanged session responds `NOT_MODIFIED` instead. Poll with the etag rather than refetching the whole session. An `ACTIVE` status means the player meets the product's requirements, and the response carries the permissions in force for them. The etag covers the whole rendered response, including the `permissions`, `ageStatus` and `ageCategory` derived from your product and jurisdiction configuration — so a configuration change moves the etag even when the session itself did not change. A session that has ended returns HTTP 400 with `NOT_FOUND`, as if it never existed. A session ends when a parent removes access in Family Connect or when you delete it with `/session/delete`. Each one sends a `Session.Delete` webhook whose `revocation` object says who ended the session (`actor`) and why (`reason`). These values are open sets.