---
canonical_url: "https://docs.composio.dev/toolkits/keyzy"
markdown_url: "https://docs.composio.dev/toolkits/keyzy.md"
product: "platform"
version: null
last_updated: null
---

# Keyzy

Keyzy is a software licensing platform for registering, validating, updating, and managing licenses and device activations.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 14
- **Triggers:** 0
- **Slug:** `KEYZY`
- **Version:** 00000000_00

## Tools

### Delete Activation

**Slug:** `KEYZY_DELETE_ACTIVATION`

Permanently and irreversibly delete an activation record by its numeric ID using a write-enabled App Key. This operation cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `activation_id` | integer | Yes | Numeric activation record ID to permanently and irreversibly delete. This operation cannot be undone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete License

**Slug:** `KEYZY_DELETE_LICENSE`

Permanently delete a Keyzy license and all activation records associated with it. This cascading deletion is irreversible. Confirm the serial and current license type before calling. Requires a write-enabled App Key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `serial` | string | Yes | License serial number to permanently delete. This irreversible operation also deletes every activation associated with the license. |
| `license_type` | string ("perpetual" | "subscription" | "trial") | Yes | Current license type, used by Keyzy as a deletion safety match. Must be perpetual, subscription, or trial. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Encrypted License File

**Slug:** `KEYZY_DOWNLOAD_ENCRYPTED_LICENSE_FILE`

Activate or renew a semi-online Keyzy license and download its encrypted offline license file. A new host can consume an activation slot, and a repeat download resets the file's offline-license lifetime.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `serial` | string | Yes | License serial number. |
| `host_id` | string | No | Device host identifier. Supplying a new host can create or refresh a semi-online activation and consume a device slot. |
| `device_tag` | string | No | Optional human-readable device label. |
| `product_code` | string | Yes | Keyzy product code for the encrypted license file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get License

**Slug:** `KEYZY_GET_LICENSE`

Return customer, SKU, type, registration, and validity-period details for one license serial.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `serial` | string | Yes | License serial number to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Activations

**Slug:** `KEYZY_LIST_ACTIVATIONS`

Return all activation records associated with one license serial number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `serial` | string | Yes | License serial number whose activations should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List License Products

**Slug:** `KEYZY_LIST_LICENSE_PRODUCTS`

Return the products associated with a license serial, including product codes needed for validation. Keyzy requires a write-enabled App Key for this endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `serial` | string | Yes | License serial number whose products should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview Dealer License Registration

**Slug:** `KEYZY_PREVIEW_DEALER_LICENSE_REGISTRATION`

Check an unregistered dealer license and return the customer-registration details before submitting them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `serial` | string | Yes | Unregistered dealer license serial number to preview. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Register Dealer License

**Slug:** `KEYZY_REGISTER_DEALER_LICENSE`

Preview an offline dealer license, verify its SKU, then irreversibly register it to a customer as the license owner. The registration cannot be undone through this toolkit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional customer name used only for the irreversible registration. |
| `email` | string | Yes | Customer email address used only for the irreversible registration. |
| `serial` | string | Yes | Unregistered dealer license serial number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Register License

**Slug:** `KEYZY_REGISTER_LICENSE`

Assign an available license for an SKU to a customer and return the new serial number. If license-email delivery is enabled for the SKU, Keyzy may also email the license information to the customer. Requires a write-enabled App Key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Customer or licensee name. |
| `email` | string | Yes | Customer or licensee email address. |
| `end_at` | integer | No | Unix end timestamp. Required with start_at for subscription or trial licenses. |
| `start_at` | integer | No | Unix start timestamp. Required with end_at for subscription or trial licenses. |
| `sku_number` | string | Yes | SKU number whose available license should be assigned. |
| `license_type` | string ("perpetual" | "subscription" | "trial") | No | License type. Omit to use Keyzy's default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Activation

**Slug:** `KEYZY_UPDATE_ACTIVATION`

Activate or deactivate an existing activation record by numeric ID. Set activated to true to enable the record, or false to disable it without deleting it. Requires a write-enabled App Key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `activated` | boolean | Yes | Desired activation state: true activates the record and allows it to be used; false deactivates the record without deleting it. |
| `activation_id` | integer | Yes | Numeric activation record ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update License SKU

**Slug:** `KEYZY_UPDATE_LICENSE_SKU`

Move a license to a new SKU, changing its license type to the destination SKU's type. Moving to a trial or subscription SKU may require a separate license-term update. Requires a write-enabled App Key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `serial` | string | Yes | License serial number to move. |
| `new_sku_number` | string | Yes | Destination SKU number. |
| `current_sku_number` | string | Yes | License's current SKU number, used as a safety check. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update License Term

**Slug:** `KEYZY_UPDATE_LICENSE_TERM`

Update the validity start and/or required end time of a subscription or trial license. Requires a write-enabled App Key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_at` | integer | Yes | New license end time as a Unix timestamp. |
| `serial` | string | Yes | Subscription or trial license serial number. |
| `start_at` | integer | No | Optional new license start time as a Unix timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upgrade License

**Slug:** `KEYZY_UPGRADE_LICENSE`

Irreversibly exchange a current license for an upgrade license. WARNING: when Keyzy confirms success, it permanently deletes the current license and makes the upgrade license usable. Use only after confirming both serials and that deleting the current license is intended.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `current_serial` | string | Yes | Current license serial to exchange. WARNING: after a successful upgrade, Keyzy permanently deletes this license, so it cannot be used again. |
| `upgrade_serial` | string | Yes | Upgrade-license serial that becomes usable after the exchange. Confirm it is the intended replacement before calling because the exchange deletes current_serial. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate License

**Slug:** `KEYZY_VALIDATE_LICENSE`

Validate a Keyzy license for a product. Supplying host_id can create or refresh a device activation and consume an activation slot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `serial` | string | Yes | License serial number to validate. |
| `host_id` | string | No | Stable device host identifier. Supplying a new host can create or refresh an activation and consume a device slot. |
| `device_tag` | string | No | Optional human-readable device label. |
| `product_code` | string | Yes | Keyzy product code to validate against. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |