> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Keyzy

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

![Keyzy logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/keyzy.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=be4e10fea700ec27aa5ac450e8eaa025)

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

## Tools

> [accordion] 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
>
> **activation\_id** `integer` *required*
>
> Numeric activation record ID to permanently and irreversibly delete. This operation cannot be undone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **serial** `string` *required*
>
> License serial number to permanently delete. This irreversible operation also deletes every activation associated with the license.
>
> **license\_type** `string ("perpetual" | "subscription" | "trial")` *required*
>
> Current license type, used by Keyzy as a deletion safety match. Must be perpetual, subscription, or trial.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **serial** `string` *required*
>
> License serial number.
>
> **host\_id** `string`
>
> Device host identifier. Supplying a new host can create or refresh a semi-online activation and consume a device slot.
>
> **device\_tag** `string`
>
> Optional human-readable device label.
>
> **product\_code** `string` *required*
>
> Keyzy product code for the encrypted license file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get License
>
> **Slug:** `KEYZY_GET_LICENSE`
>
> Return customer, SKU, type, registration, and validity-period details for one license serial.
>
> #### Input Parameters
>
> **serial** `string` *required*
>
> License serial number to inspect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Activations
>
> **Slug:** `KEYZY_LIST_ACTIVATIONS`
>
> Return all activation records associated with one license serial number.
>
> #### Input Parameters
>
> **serial** `string` *required*
>
> License serial number whose activations should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **serial** `string` *required*
>
> License serial number whose products should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **serial** `string` *required*
>
> Unregistered dealer license serial number to preview.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string`
>
> Optional customer name used only for the irreversible registration.
>
> **email** `string` *required*
>
> Customer email address used only for the irreversible registration.
>
> **serial** `string` *required*
>
> Unregistered dealer license serial number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Customer or licensee name.
>
> **email** `string` *required*
>
> Customer or licensee email address.
>
> **end\_at** `integer`
>
> Unix end timestamp. Required with start\_at for subscription or trial licenses.
>
> **start\_at** `integer`
>
> Unix start timestamp. Required with end\_at for subscription or trial licenses.
>
> **sku\_number** `string` *required*
>
> SKU number whose available license should be assigned.
>
> **license\_type** `string ("perpetual" | "subscription" | "trial")`
>
> License type. Omit to use Keyzy's default.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **activated** `boolean` *required*
>
> Desired activation state: true activates the record and allows it to be used; false deactivates the record without deleting it.
>
> **activation\_id** `integer` *required*
>
> Numeric activation record ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **serial** `string` *required*
>
> License serial number to move.
>
> **new\_sku\_number** `string` *required*
>
> Destination SKU number.
>
> **current\_sku\_number** `string` *required*
>
> License's current SKU number, used as a safety check.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **end\_at** `integer` *required*
>
> New license end time as a Unix timestamp.
>
> **serial** `string` *required*
>
> Subscription or trial license serial number.
>
> **start\_at** `integer`
>
> Optional new license start time as a Unix timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **current\_serial** `string` *required*
>
> Current license serial to exchange. WARNING: after a successful upgrade, Keyzy permanently deletes this license, so it cannot be used again.
>
> **upgrade\_serial** `string` *required*
>
> Upgrade-license serial that becomes usable after the exchange. Confirm it is the intended replacement before calling because the exchange deletes current\_serial.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **serial** `string` *required*
>
> License serial number to validate.
>
> **host\_id** `string`
>
> Stable device host identifier. Supplying a new host can create or refresh an activation and consume a device slot.
>
> **device\_tag** `string`
>
> Optional human-readable device label.
>
> **product\_code** `string` *required*
>
> Keyzy product code to validate against.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
