@capgo/capacitor-android-age-signals

Read Google Play Age Signals from your Capacitor app to detect supervised accounts, guardian approvals and verified users. A small Android-only bridge for age assurance flows.

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-android-age-signals in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-android-age-signals to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Key features

• One call: checkAgeSignals() requests the current Play Age Signals for the active user.
• Supervised accounts: tells you when the user is on a supervised account and whether a guardian approved.
• Verified users: reports when Google Play verified the user's age.
• Official library: uses the Google Play age-signals library.
• Platforms: Android. Android only. iOS and web are not supported (see capacitor-age-range for both platforms).

Why Android Age Signals?

The only free Capacitor plugin for Google Play's Age Signals API. Implement COPPA and teen safety compliance with:

• Supervised account detection - Identify users with parental controls
• Age verification - Detect 18+ verified users
• Guardian approval tracking - Monitor pending approvals and denials
• Compliant features - Build age-appropriate experiences and comply with regulations
• Same JavaScript API - Compatible interface with paid alternatives

Critical for apps targeting families, children, and teens who need age-gate functionality.

Documentation

Authoritative docs live inside this repo for now. Explore the TypeScript definitions in src/definitions.ts and the Android implementation under android/ for platform behavior. Run the included example app for an end-to-end walkthrough.

Compatibility

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.

Install

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-android-age-signals` 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-android-age-signals
npx cap sync android

Google Play Age Signals is available only on Android phones with the Play Store installed.

Usage

import { AgeSignals } from '@capgo/capacitor-android-age-signals';
import { UserStatus } from '@capgo/capacitor-android-age-signals';

const result = await AgeSignals.checkAgeSignals();

if (result.userStatus === UserStatus.Supervised) {
  console.info(`Supervised user aged between ${result.ageLower} and ${result.ageUpper}`);
} else if (result.userStatus === UserStatus.Verified) {
  console.info('User is 18+ and verified by Google.');
} else {
  console.warn('No definitive age signal returned.');
}

API

• checkAgeSignals()
• getPluginVersion()
• Interfaces
• Enums

Capacitor interface for retrieving Play Age Signals.

checkAgeSignals()

checkAgeSignals() => Promise<CheckAgeSignalsResult>

Request the current Play Age Signals for the active user.

Only available on Android devices with Google Play installed.

Returns: Promise<CheckAgeSignalsResult>

Since: 0.0.1

getPluginVersion()

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

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0

Interfaces

CheckAgeSignalsResult

Structured result returned by {@link AgeSignalsPlugin.checkAgeSignals}.

Enums

UserStatus