Skip to main content

11 posts tagged with "documentation"

View All Tags

Rate limits documentation

Default rate limits for the k-ID API and for user-facing age verification and parental consent flows are now documented on a dedicated page.

What's new​

  • API rate limits. Calls to the k-ID API are limited per product: 500 RPS in live mode and 10 RPS in test mode. Requests over the limit return HTTP 429 Too Many Requests.
  • Age verification and parental consent flow rate limits. User-facing flows are limited per product: 100 RPS in live mode and 20 RPS in test mode. When the limit is hit, the user sees an in-flow error asking them to wait and try again (no 429 is surfaced to your server).
  • Requesting an increase. These are defaults. Contact your k-ID representative if your product needs higher capacity.
  • Prelaunch checklists updated. Both the CDK and AgeKit+ prelaunch checklists now reference rate limits explicitly and link to the new page, since live mode ceilings are significantly higher than test mode.

Documentation​

Mock Providers toggle, reorderable verification methods, and COPPA 2026 guide

Today's release adds two new Compliance Studio capabilities and a new developer guide for the COPPA 2026 Rule Amendments.

What's new​

  • Mock Providers / Real Providers toggle. Verification flows running in Test Mode now show a TEST MODE toolbar with a switch between Mock Providers (the default) and Real Providers. Mock Providers presents a built-in simulator that lets you submit personas (Adult, Teen, Child, or Passes / Fails Age Check), enter a custom age range or date of birth, and simulate Inconclusive or Fraudulent failures. Submissions flow through the same server path as real providers, so webhooks, sessions, and DOM events behave identically.
  • Verification method ordering. Each enabled method on the Assurance and Verification tab now has a drag handle. Drag methods to change the order shown to users in the Family Connect widget, use Reset to default order to restore the k-ID default, and apply different orders per-market via Market Specific Rules.
  • New Compliance Guides section. A new top-level docs section for compliance playbooks launches today with its first entry: 2026 COPPA Rule Amendments. The guide walks COPPA-subject operators through the configuration updates needed before the April 22, 2026 enforcement date.

Documentation​

Configure verification methods as fallbacks

You can now configure each verification method listed under the Assurance and Verification tab as Fallback only, in addition to enabled or disabled.

What's new​

  • Fallback only: A method with this setting is offered only after the user has attempted another verification method and that attempt didn't produce an age signal (no conclusive age determination). It won't appear in the initial list of methods.
  • Why it helps: You can keep a stronger or alternative method in reserve for cases where a lighter method couldn't reach a verification outcome, without showing every option up front.

Documentation​

  • Adult verification: Assurance and Verification tab, where you enable, disable, or set Fallback only on each verification method
  • Verification methods: overview of verification behavior, including a callout on Fallback only

Short URL field in age verification API responses

Age verification creation responses (from endpoints such as POST /age-verification/perform-access-age-verification) now include shortUrl in addition to id and url.

What's new​

  • Compact link: shortUrl is a shorter link that redirects to the same verification experience as the full url. Use it when a long query string is a poor fit, for example for QR codes or when the user completes verification on another device.
  • Full URL unchanged: The session JWT remains on the full url (token query parameter). Don't try to shorten or rebuild that URL yourself.
  • Opaque value: Treat shortUrl as an opaque string. Display or encode it as returned, and don't rely on a fixed path or query layout, which might change in the future.

Learn more​

Platform age signals documentation

We've published end-to-end documentation for platform age signals: how Apple iOS, Google Play, Xbox, Meta Horizon, and k-ID age data flows into k-ID, when the age gate can be skipped, and how verified versus unverified signals interact with high-risk permissions and age assurance.

What's New​

CDK — Platform age signals​

  • Platform age signals — Quick integration paths, API map, recommended request sequence, how POST /age-gate/check uses a platform signal, supported platforms and verified declaration types, and verified versus unverified signal behavior.
  • Platform signal details — Per-platform field shapes, how to obtain each native signal, endpoint-by-endpoint notes (get-requirements, check, get-default-permissions, session/get, get-platform-age-range, session/upgrade), validation, age conflicts, and k-id signal rules.

API reference (OpenAPI)​

Descriptions for session upgrade, AgeVerification, and platformAgeSignal now use verified platform signal wording consistently with the docs above.

Documentation​

Browser and device compatibility

We've added a new Browser and device compatibility page to the docs so you can quickly check which browsers and devices are supported for our age verification flows.

What's New​

Browser and device compatibility​

The new page lists minimum browser versions for desktop and mobile, plus requirements for embedded browsers (ASWebAuthenticationSession on iOS, Chrome Custom Tabs on Android). This consolidates the combined compatibility requirements across our verification providers into a single reference.

New documentation​

Additional legal links and Check age gate options

We've documented additional legal links in Developer Details and the new options parameter on the Check age gate API so you can show platform-specific legal documents (e.g., Xbox, PlayStation, Steam) in consent flows.

What's New​

In Compliance Studio, on the Developer Details tab for a product, you can now add optional Additional legal links that appear in consent flows:

  • Title and Link: Localized display title and URL (same language options as your main legal documents).
  • Variant ID: Identifier used when calling the Check age gate API (e.g., xbox-tos, playstation-privacy-policy). Required if Always display is off.
  • Always display: When on (default), the link is always shown in consent flows. When off, the link is only shown when your game calls the age-gate API with the matching variant ID in options.

Use these when your game is distributed on multiple platforms and each platform requires different legal document URLs.

Check age gate API — options parameter​

The POST /api/v1/age-gate/check request body now supports an optional options object:

  • termsOfServiceDocument: Variant ID for Terms of Service (must match a configured additional legal link).
  • privacyPolicyDocument: Variant ID for Privacy Policy (must match a configured additional legal link).
  • additionalLegalLinks: Array of variant IDs for extra legal documents to display with ToS and Privacy Policy (each must match a configured additional legal link).

When a challenge is created, the consent screen shows the requested legal links instead of the default product Privacy Policy and Terms of Service.

Documentation​

Verification URL validity and get-status documentation

We've updated the age verification docs to cover URL validity, expired URLs, and status checks.

What's New​

  • URL validity: The verification URL is valid for 2 weeks. The expiry is in the JWT token query parameter—use the standard exp claim to check if a URL is still valid.
  • Expired URLs: Call /age-verification/get-status with the saved verification ID. If not found, create a new verification.
  • Status without the URL: Use get-status with the verification ID to check status anytime (e.g. after URL expiry or if the webhook was missed).
  • Retention: Verifications that stay PENDING for over 2 weeks are deleted and no longer returned by get-status.

Updated documentation​

Verification Documentation Updates

We've updated the verification documentation to improve method field descriptions and clarify guidance.

What's New​

Verification Result Documentation​

Updated the Verification.Result webhook documentation:

  • ageCategory guidance: Clarified that ageCategory is always present for PASS status and should be used for access control decisions rather than raw age values
  • Method field updates:
    • Removed self-confirmation and email-confirmation from the methods field list
    • Updated age-estimation-scan description to indicate it's a facial age estimation scan that returns an age range (no DOB)

Updated Documentation​

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