Mobile Integration Guidance for Widgets and Age Verification
We've updated the documentation to clarify how k-ID should be integrated on mobile: build the age gate and consent flows natively, and reserve web embeds for age verification URLs.
What's New
Mobile Guidance for Age Gate and End-to-End Widgets
The age gate and end-to-end widgets aren't recommended for mobile apps. On mobile, use the custom workflow and build the age gate and consent UX elements natively, following the CDK UX guidelines.
The only web embeds supported on mobile are the age verification and age assurance URLs returned by the k-ID API. See the mobile apps guide for the specific endpoints and challenge types.
Reworked Mobile Apps Guide
The Mobile apps guide has been re-centered on age verification, the flow where web embedding on mobile is still recommended:
- All examples (server request, client fetch, display, and callback handling) now use the age verification URL from
/age-verification/perform-access-age-verification - Result handling covers the
Verification.ResultDOM event and server-side confirmation via/age-verification/get-status
Default Browser Method
A default external browser method has been documented under the mobile implementation methods. It works on both Android (Intent.ACTION_VIEW) and iOS (UIApplication.open), fully supports AgeKeys, and returns focus to your app through the redirectUrl callback.
Device Orientation Guidance
Age verification works best in portrait orientation. Because in-app browser surfaces inherit your app's orientation lock, apps with a locked landscape orientation should open the verification URL in the default external browser. The browser manages its own orientation, so users can rotate to portrait, and the redirectUrl callback returns them to your app when the flow completes.
Updated Documentation
- Mobile apps: Re-centered on age verification, plus new default browser and device orientation sections
- CDK Embedded flow: Added a note that the end-to-end and age gate widgets aren't recommended on mobile
- CDK Overview: Added mobile guidance to the integration approaches comparison
- CDK Custom workflow: Noted the custom workflow as the recommended approach for mobile apps
- Verifiable Parental Consent (VPC): Added a note that this widget-based guide is for web only
Next Steps
- If you're integrating on mobile, build your age gate and consent UX natively using the custom workflow and CDK UX guidelines
- Embed only age verification URLs on mobile, and use the default browser method for landscape-locked apps