capacitor-age-range

Ask the operating system for the user's age range instead of collecting birthdates: Google Play Age Signals on Android and Apple Declared Age Range on iOS. Helps apps meet age assurance rules with one call.

• One call: requestAgeRange() returns the user's age range through the platform API.
• Android: uses the Google Play Age Signals library.
• iOS: uses Apple's DeclaredAgeRange framework.
• Privacy friendly: the app receives an age range from the OS, not a birthdate.
• Platforms: iOS and Android. Not available on web (requestAgeRange() throws).

A unified, free, and lightweight age range plugin:

• Cross-platform - Single API for both Android and iOS
• Privacy-preserving - No birth dates collected, only age ranges
• Regulatory compliance - Meet COPPA, KOSA, and regional age-appropriate design requirements
• Automatic mapping - Platform-specific responses mapped to a unified format
• Modern package management - Supports both Swift Package Manager (SPM) and CocoaPods
• Zero dependencies - Minimal footprint beyond platform SDKs

The most complete doc is available here: https://capgo.app/docs/plugins/age-range/

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-age-range` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-age-range
npx cap sync

• iOS 15+ (plugin compiles and runs, returns NOT_AVAILABLE on older versions)
• iOS 26+ for actual age range functionality (DeclaredAgeRange framework)
• Xcode 26+

requestAgeRange() needs this capability signed into the iOS app. Edit two files, then enable it on the App ID.

Paste these two lines inside the existing <dict> (keep keys you already have, such as aps-environment):

	<key>com.apple.developer.declared-age-range</key>
	<true/>

If that file does not exist, create ios/App/App/App.entitlements with this exact content:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>com.apple.developer.declared-age-range</key>
	<true/>
</dict>
</plist>

The entitlements file is ignored until this line is on the App target for both Debug and Release. Search the file for the two App-target buildSettings blocks that contain PRODUCT_BUNDLE_IDENTIFIER (not the project-level configs) and add:

CODE_SIGN_ENTITLEMENTS = App/App.entitlements;

It should sit next to the other signing keys, for example:

CODE_SIGN_ENTITLEMENTS = App/App.entitlements;
CODE_SIGN_STYLE = Automatic;

Xcode UI does the same two files: Target → Signing & Capabilities → + Capability → Declared Age Range.

1. Open Identifiers → your App ID → enable Declared Age Range.
2. Regenerate provisioning profiles, then archive again.

Without steps 1 to 3, in-app requestAgeRange() fails. This entitlement does not control App Store download of 18+ apps in Australia, Brazil, and Singapore, Apple performs that adult confirmation automatically from the listing age rating.

Verify before shipping:

npx @capgo/cli@latest build prescan

The check id is ios/entitlements-declared-age-range.

On iOS, requestAgeRange() presents a system dialog where the user (or their guardian via Family Sharing) declares their age range. The ageGates option controls the age boundaries shown in the dialog (default: [13, 16, 18]).

• Android API 24+ (minSdk)
• Google Play Store installed and up to date

On Android, the plugin queries Google Play Age Signals API in the background, no user prompt is shown. The Play Store determines the user's age verification status from their Google account.

No additional permissions or manifest changes are needed.

Not supported. The web implementation throws 'AgeRange does not have web implementation'.

• requestAgeRange(...)
• getPluginVersion()
• Interfaces
• Type Aliases

Cross-platform age range detection plugin.

Uses Google Play Age Signals on Android and Apple DeclaredAgeRange on iOS.

requestAgeRange(options?: RequestAgeRangeOptions | undefined) => Promise<AgeRangeResult>

Request the user's age range.

On Android: queries Google Play Age Signals API (no user prompt). On iOS: presents the system DeclaredAgeRange dialog (requires iOS 26.2+).

Returns: Promise<AgeRangeResult>

Since: 8.0.0

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 8.0.0

Result of the age range request.

Options for the age range request.

Top-level status of the age range request.

'SHARING' | 'DECLINED_SHARING' | 'NOT_AVAILABLE' | 'ERROR'

How the age range was declared or determined.

'SELF_DECLARED' | 'GUARDIAN_DECLARED' | 'VERIFIED' | 'UNKNOWN'

Android-specific Google Play user status values.

'VERIFIED' | 'SUPERVISED' | 'SUPERVISED_APPROVAL_PENDING' | 'SUPERVISED_APPROVAL_DENIED' | 'UNKNOWN' | 'EMPTY'

import { AgeRange } from '@capgo/capacitor-age-range';

// Request age range with default gates (13, 16, 18)
const result = await AgeRange.requestAgeRange();

switch (result.status) {
  case 'SHARING':
    console.log('Age range:', result.ageLower, '-', result.ageUpper);
    console.log('Source:', result.declarationSource);
    break;
  case 'DECLINED_SHARING':
    console.log('User declined to share age');
    break;
  case 'NOT_AVAILABLE':
    console.log('Age range API not available');
    break;
  case 'ERROR':
    console.log('Error occurred');
    break;
}

// Custom age gates (iOS only)
const result2 = await AgeRange.requestAgeRange({ ageGates: [13, 18] });