> ## Documentation Index
> Fetch the complete documentation index at: https://docs.keyport.sbs/llms.txt
> Use this file to discover all available pages before exploring further.

# KeyPort Documentation

> License key management for software developers — live validation API, IP controls, webhooks, and official SDKs.

KeyPort is a license key management platform. You integrate once with the live public API, manage licenses from the dashboard, and KeyPort handles validation, IP controls, webhooks, and customer license workflows.

<Tip>
  Try the public API directly from the docs on [Validate](/api-reference/validate) and [License Lookup](/api-reference/license-lookup).
</Tip>

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/getting-started/quickstart">
    Create a product, issue a license, and make your first validation call in five minutes.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/validate">
    Full request and response reference for `POST /api/v1/validate` and `GET /api/v1/license/:key`.
  </Card>

  <Card title="SDKs" icon="box" href="/sdks/index">
    Official SDKs for Node, Express, NestJS, Python, and Java.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/webhooks/overview">
    Receive signed license lifecycle events in your own systems.
  </Card>
</CardGroup>

## How it works

<Steps>
  <Step title="Create a product">
    Sign in at [app.keyport.sbs](https://app.keyport.sbs), create an organization, and add a product. KeyPort gives you a product API key.
  </Step>

  <Step title="Issue licenses">
    Create licenses for your customers in the dashboard. Attach them to a customer email or Discord ID and optionally set expiry and IP limits.
  </Step>

  <Step title="Validate from your app">
    Call `POST /api/v1/validate` from your backend with the product API key and the customer's license key. KeyPort returns a structured result.
  </Step>

  <Step title="Enforce the result">
    Check `valid === true` to grant access. Handle typed status values like `expired`, `revoked`, or `ip_limit_reached` as distinct customer-facing states.
  </Step>
</Steps>

## Features

KeyPort covers the end-to-end license lifecycle for modern applications:

* **Platform Core**: Organization and multi-product management from a single developer dashboard.
* **License Engine**: High-performance key generation and validation with automated expiry enforcement.
* **Advanced IP System**: Three-tier IP tracking (Platform, Org, License) with auto-registration and CIDR blacklist support.
* **Activation Limits**: Control exactly how many unique devices or environments can use a single license.
* **Version Control Module**: Gating access by product version, managing changelogs, and pinning licenses to specific releases.
* **Custom Responses**: Attach metadata or dynamic JSON payloads to validation calls.
* **Webhook Infrastructure**: Real-time signed delivery of license lifecycle events with automatic retries.
* **Customer Portal**: Self-service management for end-customers to view history and manage their own licenses.
* **Official SDKs**: Ready-to-use libraries for Node.js, Express, NestJS, Python, and Java.
* **Enterprise Security**: Signed validation responses, SLA support, and custom overrides for high-scale deployments.
* **Admin Moderation**: Platform-level tools for handling suspensions, global customer bans, and billing overrides.
* **Billing & Lifecycle**: Integrated recurring subscriptions, customer tracking, renewal handling, and cancellation controls.
* **Advanced Analytics**: Detailed usage tracking, activation geodata, and product performance metrics.
* **Custom Permissions**: Fine-grained member roles for organization collaboration.
