EYMINT
DocumentationAPI Reference
BlogDashboard
EYMINT
SectionsDocumentationAPI Reference
Go to Dashboard

For AI agents: the documentation index is at /llms.txt. Every docs page is also available as markdown by adding .md to its URL.

Getting Started

  • Keymint Documentation
  • Introduction
  • Getting Started
  • License Keys
  • Changelog

SDK References

  • Software Development Kits (SDKs)
  • Node.js SDK
  • Go SDK
  • Python SDK
  • C# SDK

Integration Guides

  • Integration Guides
  • Customer Portal for Vendors
  • Roles & Permissions
  • Radar Alert Destinations
  • Payment Provider Integrations
  • Stripe Subscription Licensing
  • Email Delivery
  • API Key Management
  • Webhook Deliveries
  • Analytics and Retention
  • Dashboard Workflows
  • Electron Licensing
  • PyQt Licensing
  • Tauri Licensing
  • Next.js SaaS Licensing

Licensing Guides

  • Licensing Concepts
  • Node-Locking & Machine Identifiers
  • Floating Licenses
  • Offline Verification
  • License Radar
  • Public Key Management and Rotation
  • Feature Flags
  • Webhooks & Events

Templates

  • Starter Templates
  • Electron License Starter
  • PyQt License Starter
  • Tauri License Starter
  • Next.js SaaS License Starter

Security & Trust

  • Security & Trust

Support

  • Frequently Asked Questions
  • Customer Portal
  • Using the Customer Portal
  • Workspace Settings and Roles

Legal

  • Privacy Policy
  • Subprocessors
  • Data Processing Agreement
  • Security Overview
  • Terms of Service
  • Service Level Agreement (SLA)
  • GDPR Compliance

Feature Flags

Define product-level Keymint feature flags, assign them to license keys, and read enabled capabilities from activation and floating checkout metadata.

Feature Flags allow you to control access to granular features of your application on a per-license basis. Instead of manually entering feature names when generating a license, you can predefine them on the product itself. This prevents typos and keeps the values your client-side integration receives consistent.

Core Concepts

  1. Predefined Features: Standard features defined at the product level (e.g., Pro Mode, API Access, Advanced Analytics).
  2. Key Toggles: When generating or updating a license key, predefined features are presented as checklist toggles.
  3. Ad-hoc Custom Features: Any unique, one-off features can still be typed and added manually to individual keys.
  4. Client-Side Validation: Predefined and custom features are returned as a boolean map inside the metadata payload of license activation and checkout calls.

1. Defining Product Features

To set up standard feature flags for a product:

  1. Navigate to the Products section of your Keymint dashboard.
  2. Create a product, or open an existing product and choose Edit product from its … menu.
  3. Find the Product features field.
  4. Enter a feature name (e.g., Pro Mode) and press Enter or click Add.
  5. Save the product. Predefined features now appear as badges on the product page.

2. Allocating Features to Licenses

When creating or modifying a license key:

  1. Open Generate license keys (from the product page) or select keys under Licenses and choose Edit.
  2. When generating, click More options. When editing, the options are below the basics.
  3. Open Feature flags. The product's features are listed with toggle switches.
  4. To add a custom, one-off feature for these keys, use Add a flag.
  5. Generate or save. The enabled features are stored in each license's metadata.

3. Validating Features in Client Applications

When your application activates a license key via the POST /key/activate endpoint (or checks out a seat via POST /key/checkout), the Keymint API returns the license's metadata, including the enabled features in metadata.features. Activation also adds the recorded hostId to metadata.

Activation Response Example

json
{
  "code": 0,
  "message": "License valid",
  "metadata": {
    "hostId": "mac-studio-m2",
    "is_trial": false,
    "features": {
      "Pro Mode": true,
      "API Access": false,
      "Custom Plugin": true
    }
  }
}

Checking Features in Code

You can conditionally execute code based on the toggles returned:

// Activate the key
const result = await client.activateKey({
  productId: 'YOUR_PRODUCT_ID',
  licenseKey: 'A8E2K-9F1BC-3D4GH-7J2KM'
});

const features = result.metadata?.features || {};

if (features['Pro Mode']) {
  console.log("Welcome to Pro Mode!");
  enableProFeatures();
} else {
  restrictToBasicFeatures();
}

On this page

  • Core Concepts
  • 1. Defining Product Features
  • 2. Allocating Features to Licenses
  • 3. Validating Features in Client Applications
  • Activation Response Example
  • Checking Features in Code