Introduction
The k-ID Compliance Development Kit (CDK) provides developers with powerful, embeddable web flows that enable quick deployment of compliance solutions. These flows are designed to be easily integrated into applications through simple iframe embeds, with support for custom branding to match your product's look and feel.
What is the CDK?
The CDK handles complex compliance requirements while allowing developers to maintain control over the user experience. Instead of building compliance flows from scratch using individual APIs, the CDK provides pre-built, jurisdiction-aware widgets that automatically adjust their behavior based on local regulations and your product configuration.
Key Benefits
- Rapid Integration: Embed compliance flows with simple iframe integration
- Automatic Compliance: Flows automatically adapt to local jurisdictions and regulations
- Custom Branding: Match your product's look and feel with configurable branding options
- Comprehensive Coverage: Handle age verification, parental consent, data notices, and permission management
- Real-time Updates: Compliance logic updates automatically without code changes
Available Flows
The CDK consists of embeddable widgets that handle specific compliance workflows:
| Flow | Description | API Endpoint | Documentation Link |
|---|---|---|---|
| Access Age Verification | Verifies if a user's claimed age or age category is accurate using configured verification methods (facial scanning, ID verification, parental attestation). Returns verification results via webhooks and JavaScript events. | POST /age-verification/perform-access-age-verification | API Reference |
| End-to-End | Handles the complete verified parental consent (VPC) flow within a single widget, including age collection, verification, and consent completion. Streamlines the entire process in one embeddable component. | POST /widget/generate-e2e-url | API Reference |
| Age Gate | Collects user age using jurisdiction-appropriate methods and handles the complete flow from age collection through parental consent if needed. Emits events for challenges, results (PASS/FAIL/PROHIBITED), and data lite mode navigation. | POST /widget/generate-age-gate-url | API Reference |
| Facial Age Estimation | Dedicated facial age estimation verification flow using privacy-preserving technology. No biometric data leaves the user's device during the scanning process. | POST /age-verification/perform-facial-age-estimation | API Reference |
| ID Verification | Document-based age verification using government-issued IDs such as passports, driver's licenses, and national ID cards. Provides definitive age verification for supported document types. | POST /age-verification/perform-id-verification | API Reference |
| Data Notices | Displays product data notices and essential permissions, collecting user consent. Shows jurisdiction-appropriate disclosures and handles consent acceptance workflow. | POST /widget/generate-direct-notices-url | API Reference |
| Permission Management | Allows 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 | API Reference |
| Trusted Adult Verification | Verifies that a user is a trusted adult (parent/guardian) using appropriate verification methods including credit card verification and social security number validation for contract-age proof. | POST /age-verification/perform-trusted-adult-verification | API Reference |
| Age Appeal | Allows users who were previously flagged as underage to re-verify their age using more stringent verification methods. Provides a path for users to contest age determination results. | POST /age-verification/perform-age-appeal | API Reference |