📄️ Workflow
The flow chart below shows a view of the k-ID Engine workflow. API calls are identified at the points in the workflow where they are used.
📄️ Managing Sessions
The k-ID `Session contains the collection of permissions and age status for the current player and location. Every player requires an active Session. The game should consult the active Session` to determine whether features are enabled or disabled in the game.
📄️ Getting the Player's Age
Jurisdictional Requirements for Age Collection
📄️ Checking Age
If an age gate was required, an API call to /age-gate/check now must be made to determine the next step in the workflow. If the player’s age is below the minimum age for the game configured in the Publisher Portal, the returned status field will be PROHIBITED. At this point, the player should be blocked from continuing in the game. If the player gave a date of birth that requires verifiable parental consent in the current location, then the status field will have the value CHALLENGE and an ID to a new Consent Challenge will be returned in a field called challengeID. The game must then ask the player to seek parental consent. Finally, if the status value is PASS, then the player can continue into the game.
📄️ Seeking Parental Consent
In the case where the value CHALLENGE is returned in the status field of the /age-gate/check, the challengeId field in the response contains the ID of the Consent Challenge in the k-ID Engine. A window should now be shown that allows the player to seek parental consent.
📄️ Using Session Permissions
Once the user passes the age gate check, either because they are of age to proceed or consent has been granted by a parent, then the game can retrieve all of the jurisdiction-specific permissions for the current player. This is done either from the result of the /age-gate/check call when the status field is PASS, or, if the Session was previously created and cached, invoking /session/get.
📄️ Appealing Age Check
When an age assurance check fails or a player otherwise wants to appeal the age category that the game has assigned to them, they are able to create an age appeal workflow. To create an age appeal, a player must be directed to the Family Portal Age Appeal URL. There they will be able to prove their age using the available methods in their jurisdiction (e.g., providing a photo ID).
📄️ Webhooks
Webhooks let you subscribe to events happening in the k-ID Engine as they
📄️ Requesting Consent For New Permissions
(This is a Roadmap Feature and is marked Experimental in the API documentation)