CDK

Compliance Development Kit (CDK)

The k-ID Compliance Development Kit (CDK) is an enterprise-grade compliance framework that automatically manages regulatory logic and compliance settings. It intelligently determines which features and content are accessible to players based on their age, jurisdiction, and parental consent status. Leveraging global compliance data from k-ID's Regulatory Hub, CDK enables game and app developers to deliver compliant experiences across different ages and jurisdictions.

What's the CDK?

The CDK is a comprehensive compliance solution that encapsulates all of the functionality needed for age gate, Verifiable Parental Consent (VPC), sessions, permissions, data notices, and trusted adult preferences. All compliance policies are configured through the Compliance Studio, where you define and manage your product's regulatory requirements.

The core value of CDK is its ability to:

  • Maintain compliance logic: Automatically determine which features and content can be offered to different age groups based on jurisdiction requirements
  • Determine consent requirements: Identify which players need parental consent based on their age and jurisdiction
  • Manage permissions: Control which features are enabled or disabled for each player based on age, jurisdiction, and parental consent
  • Handle data notices: Determine what data notices must be displayed based on jurisdiction requirements

All of this logic is maintained by CDK with global compliance data from k-ID's Regulatory Hub, ensuring your application stays compliant as regulations evolve.

Integration approaches

CDK supports two integration approaches that allow you to use its compliance logic:

Widgets

Use pre-built widgets that handle the complete compliance flow. Perfect for quick integration of a website or web app with minimal code changes.

  • Hosted widget URL: present in the browser as an iframe, pop-up, or redirect. Also fully supported in native apps, through a system browser surface on mobile or a QR code on console, though we recommend the custom UX workflow there (see below)
  • Automatic flow handling based on product configuration
  • Customizable branding
  • See Embedded flow for details

Custom UX workflows

Build completely custom compliance experiences with the k-ID API. Full control over the user interface and workflow while still leveraging CDK's compliance logic.

  • Complete UI/UX control
  • Custom workflow logic
  • Advanced scenarios
  • See Custom workflow for details

In native apps, we recommend the custom UX workflow

For native mobile apps, consoles, and other surfaces that don't run in a browser, build the age gate and consent steps natively with the custom workflow:

  • The player stays in your game. A widget opens in a system browser on mobile, or on the player's phone on console, and the player has to find their way back. A native age gate keeps them in your app, and hands off only when a challenge needs a parent or a verification.
  • It looks and feels like your game. You control the layout, input (touchscreen or controller), and wording, following the CDK UX guidelines, instead of a web page built for a browser.
  • Simpler result handling. /age-gate/check answers your app directly, so the age gate itself needs no redirect deep link and no widget status to poll.

The widgets are fully supported in native apps too; see Presenting the widget URL. Either way, challenge and verification URLs open outside your app: in a system browser on mobile (see the mobile apps guide), or as a QR code on console.

How it works

  1. Configure in Compliance Studio: Set up your product's compliance requirements, permissions, data notices, and verification methods in the Compliance Studio

  2. CDK maintains compliance logic: CDK automatically accesses k-ID's Regulatory Hub to:

    • Determine jurisdiction-specific age requirements
    • Identify which players need parental consent
    • Calculate which permissions can be granted based on age and jurisdiction
    • Determine what data notices must be displayed
  3. Integrate into your application: Choose either widgets or custom UX workflows to integrate CDK's compliance logic

  4. Automatic compliance: CDK automatically determines what features and content are allowed for each player, ensuring compliance without additional code

Available widgets and APIs

CDK provides widgets and APIs that handle specific compliance workflows:

FlowDescriptionAPI Endpoint
End-to-EndHandles the complete Verifiable Parental Consent (VPC) flow within a single widget, including age collection, verification, and consent completion. Streamlines the entire process in one embedded component.POST /widget/generate-e2e-url
Age GateCollects user age using jurisdiction-appropriate methods and handles the complete flow from age collection through trusted adult consent if needed. Emits events for challenges, results (PASS/FAIL/PROHIBITED), and data lite mode navigation.POST /widget/generate-age-gate-url
Data NoticesDisplays product data notices and essential permissions, collecting user consent. Shows jurisdiction-appropriate disclosures and handles consent acceptance workflow.POST /widget/generate-direct-notices-url
Permission ManagementAllows users and parents to view and update permission settings for an active session. Enables granular control over feature permissions and data usage preferences.POST /widget/generate-manage-session-permissions-url

Key benefits

  • Automatic compliance logic: CDK maintains all compliance settings and logic to determine what's allowed for each player
  • Global compliance data: Uses k-ID's Regulatory Hub to stay up-to-date with jurisdiction requirements
  • Flexible integration: Choose between widgets or custom UX workflows
  • Centralized configuration: All compliance settings configured in the Compliance Studio
  • Real-time updates: Compliance logic updates automatically without code changes as regulations evolve

Getting started

On this page