Skip to main content

3 posts tagged with "widgets"

View All Tags

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:

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

Age Gate Widget Redirect URL Support

We've added support for redirectUrl as an optional parameter to the age gate widget endpoint.

What's New​

Age Gate Widget API Update​

The /widget/generate-age-gate-url endpoint now supports an optional redirectUrl parameter within the options object. This allows you to specify a URL to redirect to after the age gate widget completes, similar to the end-to-end widget endpoint.

The redirectUrl parameter supports HTTP/HTTPS URLs or mobile deeplinks with custom protocol schemes.

Updated API​

Widget.ExitReview Clarification and API Updates

We've clarified when to close widget UI for age verification and VPC flows, and added redirectUrl support to the MegaWidgetOptions schema.

What's New​

Widget.ExitReview Clarification​

We've updated the documentation to clarify that Widget.ExitReview is the signal that should determine when to close the UI for age verification and VPC flows.

Updated documentation:

  • Age verification guide - Added guidance on listening for Widget.ExitReview to close the verification UI
  • VPC guide - Added guidance on listening for Widget.ExitReview to close the VPC widget UI
  • CDK embedded flow - Added guidance on listening for Widget.ExitReview to close the widget UI

All language versions (English, Japanese, Simplified Chinese, and Korean) have been updated with this clarification.

API Updates​

redirectUrl in MegaWidgetOptions​

The MegaWidgetOptions schema now includes redirectUrl support, consistent with age verification request schemas. This allows you to specify a redirect URL when using the end-to-end widget.

Updated schemas:

  • MegaWidgetOptions now includes redirectUrl field with reference to #/components/schemas/RedirectUrl

This change is available in all OpenAPI specification files (English, Japanese, Simplified Chinese, and Korean).

Documentation Improvements​

Product Image Specifications​

Added recommended aspect ratios and resolutions for product images in Compliance Studio:

  • Logo: 1:1 (square), 512×512px
  • Banner: 3:1 (wide), 2430×810px