Activate License Key
Registers a specific device (hostId) to a license key (licenseKey), consuming an activation slot if applicable. This endpoint validates the license key and associated product/customer, then adds the device information if activation is possible. Use this during initial software setup or when activating on a new device.
Endpoint
POST /activate-key
Base URL: https://docs/api.keymint.dev
Request
Send a POST request with a JSON body and Content-Type: application/json. Include the accessToken as a Bearer token in the Authorization header.
Headers
| Header | Value | Required | Description |
|---|---|---|---|
Authorization | Bearer <accessToken> | Yes | API access token for authentication. |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
productId | string | Yes | Unique product identifier (e.g., prod_...). |
licenseKey | string | Yes | License key string (e.g., lk_...). |
hostId | string | No | Unique device identifier (e.g., MAC hash, UUID). |
deviceTag | string | No | Optional user-friendly device name (e.g., “John’s Laptop”). |
Example Request
POST /activate-key HTTP/1.1
Host: api.keymint.dev
Authorization: Bearer at_verylongaccesstokenstringgeneratedforyourapplication12345678
Content-Type: application/json
{
"productId": "your_product_id_123",
"licenseKey": "xxxxx-xxxxx-xxxxx-xxxxx",
"hostId": "a1:b2:c3:d4:e5:f6-hashed-uuid-or-other-id",
"deviceTag": "Dev Workstation"
}
Responses
The API returns a JSON object with the activation status.
Success Response (200 OK)
{
"code": 0,
"message": "License valid",
"licensee_name": "Jane Doe",
"licensee_email": "jane.doe@example.com"
}
Error Responses
| Status Code | Code | Description | Example Response Body |
|---|---|---|---|
| 400 | 1 | Missing required parameters (productId, licenseKey, hostId). | {"message": "Missing required params", "code": 1} |
| 401 | 1 | Invalid accessToken. | {"message": "Invalid access token", "code": 1} |
| 403 | 2 | License not active, expired, customer inactive, or activation limit reached. | {"message": "Activation limit reached", "code": 2} |
| 404 | 1 | productId or licenseKey not found, or customer associated with key not found. | {"message": "Invalid license key", "code": 1} |
| 500 | 1 | Internal server error during activation. | {"message": "Server error", "code": 1} |