Docs
Status
Supportk-id.comCompliance Studio
EndpointsAge gate

Get default permissions

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.

GET
/age-gate/get-default-permissions

Authorization

api-key
AuthorizationBearer <token>

In: header

Query Parameters

jurisdiction*string

The jurisdiction of the player, as either an ISO 3166-1 alpha-2 country code or an ISO 3166-2 subdivision code.

Match^[A-z]{2}(-[A-z0-9]{1,3})?$
dateOfBirth?string

The player's date of birth in YYYY-MM-DD format.

Match^[0-9]{4}(-[0-9]{2}(-[0-9]{2})?)?$
Formatdate
age?integer

The player's age in years.

Range0 <= value <= 150
kuid?string

The existing k-ID user ID of the player.

Match^[A-z0-9]{8}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{12}$
Formatuuid
platformName?string

The platform providing the age signal.

Value in

  • "k-id"
  • "meta-horizon"
  • "apple-ios"
  • "google-play"
  • "xbox"
platformAgeLow?integer

The minimum age in years reported by the platform.

platformAgeHigh?integer

The maximum age in years reported by the platform.

platformCategory?string

The platform-specific age category (e.g. "digital-youth", "13-15", "teen").

platformDeclarationType?string

The declaration type from the platform (e.g. Apple AgeRangeDeclaration or Google userStatus).

platformVerificationId?string

The verification ID for the k-id platform signal.

Match^[A-z0-9]{8}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{12}$
Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/age-gate/get-default-permissions?jurisdiction=US-CA"
{  "ageStatus": "LEGAL_ADULT",  "ageCategory": "adult",  "requiresParentConsentForDataProcessing": true,  "permissions": [    {      "name": "text-chat-public",      "enabled": false,      "managedBy": "GUARDIAN"    },    {      "name": "text-chat-private",      "enabled": true,      "managedBy": "PLAYER"    },    {      "name": "forums",      "enabled": false,      "managedBy": "PROHIBITED"    }  ]}

Get age range for category POST

Converts a platform-reported age category into the age range it implies in a given jurisdiction. Supply the jurisdiction and a `platform` age signal naming the source platform and its category. Because each platform defines its own coarse categories, k-ID maps the category onto the numeric range of ages a player could be under that jurisdiction's rules.

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.