License API
License Check

10min
This API checks the validity of license against a certain hardware ID.
GET
Request
Query Parameters
hardware_id
required
String
Unique value which identifies some device/container/session or similar resource.
product
required
String
Product short code
license_key
optional
String
Required if product is key_based. Attach the license key (eq. 1111-2222-3333-4444)
username
optional
String
Required if product is user based. Attach the assigned license user email (eq. [email protected])
id_token
optional
String
Required if using SSO. Attach the id_token received from the SSO if Implicit grant authorization method is being used.
code
optional
String
Required if using SSO. Attach the code received from the SSO if Authorization code grant method is being used.
customer_account_code
optional
String
Required if using SSO. Attach the customer_account_code to which SSO provider is configured. 
license_id
optional
Number
Ensures that the action affects only the license with the specified ID. This is useful if e.g. you have multiple licenses for the same product assigned to the same user. For obtaining a list of licenses assigned to a user, see "User Licenses"
include_expired_features
optional
Boolean
is_vm
optional
String
Set as true if using virtual machine.
vm_info
optional
String
Optional virtual machine informations.
os_ver
optional
String
Version of the operating system.
hostname
optional
String
Device hostname
os_hostname
optional
String
Hostname of the OS ( check this before publishing! )
ip
optional
String
IP address
ip_local
optional
String
Local IP address ( check this before publishing! )
app_ver
optional
String
Version of the product application used with this license.
sdk_ver
optional
String
Version of the SDK used.
mac_adddress
optional
String
Device MAC address
Header Parameters
Date
required
String
eq. Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See signing of the License API calls article.
Curl
Node.js
JS
Python
Ruby
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/api/v4/check_license?hardware_id=string&product=string&license_key=string&username=string", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/api/v4/check_license?hardware_id=string&product=string&license_key=string&username=string", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));
Responses
200
Perpetual license type
{
    "id": 1683881344856259,
    "order_store_id": "26569ab2f28f402480c9bcbff41bb6fb",
    "license_active": true,
    "license_enabled": true,
    "license_type": "perpetual",
    "license_key": "GYLT-Z4YT-URJK-3F82",
    "is_trial": false,
    "validity_period": null,
    "maintenance_period": null,
    "allow_grace_period": false,
    "grace_period": 0,
    "max_activations": 8,
    "allow_unlimited_activations": false,
    "times_activated": 3,
    "start_date": null,
    "transfer_count": 2,
    "max_transfers": 0,
    "allow_overages": false,
    "max_overages": 0,
    "is_floating_cloud": false,
    "is_floating": false,
    "floating_timeout": 1,
    "can_borrow": true,
    "max_borrow_time": 3,
    "prevent_vm": false,
    "custom_fields": [
        {
            "name": "skr",
            "data_type": null,
            "value": "222"
        },
        {
            "name": "1",
            "data_type": null,
            "value": "1"
        }
    ],
    "product_features": [
        {
            "code": "1",
            "name": "feature",
            "feature_type": "consumption",
            "expiry_date": null,
            "metadata": {},
            "max_consumption": 2,
            "allow_unlimited_consumptions": false,
            "total_consumptions": 0,
            "allow_overages": false,
            "max_overages": 0,
            "reset_consumption": true,
            "consumption_period": "daily"
        },
        {
            "code": "2",
            "name": "feature2",
            "feature_type": "consumption",
            "expiry_date": null,
            "metadata": {},
            "max_consumption": 20,
            "allow_unlimited_consumptions": false,
            "total_consumptions": 0,
            "allow_overages": false,
            "max_overages": 0,
            "reset_consumption": true,
            "consumption_period": "daily"
        }
    ],
    "customer": {
        "email": "[email protected]",
        "company_name": "",
        "reference": "",
        "phone": "",
        "first_name": "T",
        "last_name": "T",
        "city": "",
        "postcode": "",
        "state": "",
        "country": "",
        "customer_account": null,
        "metadata": {
            "a": "b"
        }
    },
    "product_details": {
        "product_id": 1683881296184003,
        "product_name": "p",
        "short_code": "p",
        "authorization_method": "license-key",
        "metadata": {}
    },
    "metadata": {},
    "device_id": 1698053262137469,
    "is_borrowed": false,
    "borrowed_until": null,
    "is_expired": false,
    "version": "",
    "installation_file": "",
    "release_date": "",
    "hash_md5": "",
    "requires_version": "",
    "environment": "",
    "eula_link": "",
    "release_notes_link": "",
    "size": "",
    "channel": "",
    "license_signature": "signature"
}
Perpetual license type
{
    "id": 1683881344856259,
    "order_store_id": "26569ab2f28f402480c9bcbff41bb6fb",
    "license_active": true,
    "license_enabled": true,
    "license_type": "perpetual",
    "license_key": "GYLT-Z4YT-URJK-3F82",
    "is_trial": false,
    "validity_period": null,
    "maintenance_period": null,
    "allow_grace_period": false,
    "grace_period": 0,
    "max_activations": 8,
    "allow_unlimited_activations": false,
    "times_activated": 3,
    "start_date": null,
    "transfer_count": 2,
    "max_transfers": 0,
    "allow_overages": false,
    "max_overages": 0,
    "is_floating_cloud": false,
    "is_floating": false,
    "floating_timeout": 1,
    "can_borrow": true,
    "max_borrow_time": 3,
    "prevent_vm": false,
    "custom_fields": [
        {
            "name": "skr",
            "data_type": null,
            "value": "222"
        },
        {
            "name": "1",
            "data_type": null,
            "value": "1"
        }
    ],
    "product_features": [
        {
            "code": "1",
            "name": "feature",
            "feature_type": "consumption",
            "expiry_date": null,
            "metadata": {},
            "max_consumption": 2,
            "allow_unlimited_consumptions": false,
            "total_consumptions": 0,
            "allow_overages": false,
            "max_overages": 0,
            "reset_consumption": true,
            "consumption_period": "daily"
        },
        {
            "code": "2",
            "name": "feature2",
            "feature_type": "consumption",
            "expiry_date": null,
            "metadata": {},
            "max_consumption": 20,
            "allow_unlimited_consumptions": false,
            "total_consumptions": 0,
            "allow_overages": false,
            "max_overages": 0,
            "reset_consumption": true,
            "consumption_period": "daily"
        }
    ],
    "customer": {
        "email": "teoterzic99@gmail.com",
        "company_name": "",
        "reference": "",
        "phone": "",
        "first_name": "T",
        "last_name": "T",
        "city": "",
        "postcode": "",
        "state": "",
        "country": "",
        "customer_account": null,
        "metadata": {
            "a": "b"
        }
    },
    "product_details": {
        "product_id": 1683881296184003,
        "product_name": "p",
        "short_code": "p",
        "authorization_method": "license-key",
        "metadata": {}
    },
    "metadata": {},
    "device_id": 1698053262137469,
    "is_borrowed": false,
    "borrowed_until": null,
    "is_expired": false,
    "version": "",
    "installation_file": "",
    "release_date": "",
    "hash_md5": "",
    "requires_version": "",
    "environment": "",
    "eula_link": "",
    "release_notes_link": "",
    "size": "",
    "channel": "",
    "license_signature": "signature"
}
﻿
Responses
Every license type has unique response
Consumption
JSON
{
    "id": 1698746367168059,
    "order_store_id": "c12fc2180313481eb87e461870212c64",
    "license_active": true,
    "license_enabled": true,
    "license_type": "consumption",
    "license_key": "H4U2-AET2-N66J-X7ZR",
    "is_trial": false,
    "validity_period": null,
    "maintenance_period": null,
    "allow_grace_period": false,
    "grace_period": 0,
    "max_activations": 5,
    "allow_unlimited_activations": false,
    "times_activated": 2,
    "start_date": null,
    "transfer_count": 0,
    "max_transfers": 0,
    "allow_overages": false,
    "max_overages": 0,
    "is_floating_cloud": false,
    "is_floating": false,
    "floating_timeout": 5,
    "can_borrow": false,
    "max_borrow_time": 0,
    "prevent_vm": false,
    "custom_fields": [
        {
            "name": "skr",
            "data_type": null,
            "value": "222"
        },
        {
            "name": "1",
            "data_type": null,
            "value": "1"
        }
    ],
    "product_features": [],
    "customer": {
        "email": "",
        "company_name": "",
        "reference": "",
        "phone": "",
        "first_name": "",
        "last_name": "",
        "city": "",
        "postcode": "",
        "state": "",
        "country": "",
        "customer_account": null,
        "metadata": {}
    },
    "product_details": {
        "product_id": 1683881296184003,
        "product_name": "p",
        "short_code": "p",
        "authorization_method": "license-key",
        "metadata": {}
    },
    "metadata": {},
    "max_consumptions": 10,
    "total_consumptions": 9,
    "allow_unlimited_consumptions": false,
    "reset_consumption": false,
    "consumption_period": null,
    "device_id": 1698746439022079,
    "is_borrowed": false,
    "borrowed_until": null,
    "is_expired": false,
    "version": "",
    "installation_file": "",
    "release_date": "",
    "hash_md5": "",
    "requires_version": "",
    "environment": "",
    "eula_link": "",
    "release_notes_link": "",
    "size": "",
    "channel": "",
    "license_signature": "signature"
}
{
    "id": 1698746367168059,
    "order_store_id": "c12fc2180313481eb87e461870212c64",
    "license_active": true,
    "license_enabled": true,
    "license_type": "consumption",
    "license_key": "H4U2-AET2-N66J-X7ZR",
    "is_trial": false,
    "validity_period": null,
    "maintenance_period": null,
    "allow_grace_period": false,
    "grace_period": 0,
    "max_activations": 5,
    "allow_unlimited_activations": false,
    "times_activated": 2,
    "start_date": null,
    "transfer_count": 0,
    "max_transfers": 0,
    "allow_overages": false,
    "max_overages": 0,
    "is_floating_cloud": false,
    "is_floating": false,
    "floating_timeout": 5,
    "can_borrow": false,
    "max_borrow_time": 0,
    "prevent_vm": false,
    "custom_fields": [
        {
            "name": "skr",
            "data_type": null,
            "value": "222"
        },
        {
            "name": "1",
            "data_type": null,
            "value": "1"
        }
    ],
    "product_features": [],
    "customer": {
        "email": "",
        "company_name": "",
        "reference": "",
        "phone": "",
        "first_name": "",
        "last_name": "",
        "city": "",
        "postcode": "",
        "state": "",
        "country": "",
        "customer_account": null,
        "metadata": {}
    },
    "product_details": {
        "product_id": 1683881296184003,
        "product_name": "p",
        "short_code": "p",
        "authorization_method": "license-key",
        "metadata": {}
    },
    "metadata": {},
    "max_consumptions": 10,
    "total_consumptions": 9,
    "allow_unlimited_consumptions": false,
    "reset_consumption": false,
    "consumption_period": null,
    "device_id": 1698746439022079,
    "is_borrowed": false,
    "borrowed_until": null,
    "is_expired": false,
    "version": "",
    "installation_file": "",
    "release_date": "",
    "hash_md5": "",
    "requires_version": "",
    "environment": "",
    "eula_link": "",
    "release_notes_link": "",
    "size": "",
    "channel": "",
    "license_signature": "signature"
}
﻿
Time-Limited
JSON
{
    "id": 1698747306613849,
    "order_store_id": "ee8dc9e77d544ccfadaadedd8de56274",
    "license_active": true,
    "license_enabled": true,
    "license_type": "time-limited",
    "license_key": "H4U2-K6TU-VP6J-X7ZG",
    "is_trial": false,
    "validity_period": "2025-10-31T00:00:00.000Z",
    "maintenance_period": null,
    "allow_grace_period": false,
    "grace_period": 0,
    "max_activations": 1,
    "allow_unlimited_activations": false,
    "times_activated": 1,
    "start_date": null,
    "transfer_count": 0,
    "max_transfers": 0,
    "allow_overages": false,
    "max_overages": 0,
    "is_floating_cloud": false,
    "is_floating": false,
    "floating_timeout": 5,
    "can_borrow": false,
    "max_borrow_time": 0,
    "prevent_vm": false,
    "custom_fields": [
        {
            "name": "skr",
            "data_type": null,
            "value": "222"
        },
        {
            "name": "1",
            "data_type": null,
            "value": "1"
        }
    ],
    "product_features": [],
    "customer": {
        "email": "",
        "company_name": "",
        "reference": "",
        "phone": "",
        "first_name": "",
        "last_name": "",
        "city": "",
        "postcode": "",
        "state": "",
        "country": "",
        "customer_account": null,
        "metadata": {}
    },
    "product_details": {
        "product_id": 1683881296184003,
        "product_name": "p",
        "short_code": "p",
        "authorization_method": "license-key",
        "metadata": {}
    },
    "metadata": {},
    "device_id": 1698747388694869,
    "is_borrowed": false,
    "borrowed_until": null,
    "is_expired": false,
    "version": "",
    "installation_file": "",
    "release_date": "",
    "hash_md5": "",
    "requires_version": "",
    "environment": "",
    "eula_link": "",
    "release_notes_link": "",
    "size": "",
    "channel": "",
    "license_signature": ""
}
{
    "id": 1698747306613849,
    "order_store_id": "ee8dc9e77d544ccfadaadedd8de56274",
    "license_active": true,
    "license_enabled": true,
    "license_type": "time-limited",
    "license_key": "H4U2-K6TU-VP6J-X7ZG",
    "is_trial": false,
    "validity_period": "2025-10-31T00:00:00.000Z",
    "maintenance_period": null,
    "allow_grace_period": false,
    "grace_period": 0,
    "max_activations": 1,
    "allow_unlimited_activations": false,
    "times_activated": 1,
    "start_date": null,
    "transfer_count": 0,
    "max_transfers": 0,
    "allow_overages": false,
    "max_overages": 0,
    "is_floating_cloud": false,
    "is_floating": false,
    "floating_timeout": 5,
    "can_borrow": false,
    "max_borrow_time": 0,
    "prevent_vm": false,
    "custom_fields": [
        {
            "name": "skr",
            "data_type": null,
            "value": "222"
        },
        {
            "name": "1",
            "data_type": null,
            "value": "1"
        }
    ],
    "product_features": [],
    "customer": {
        "email": "",
        "company_name": "",
        "reference": "",
        "phone": "",
        "first_name": "",
        "last_name": "",
        "city": "",
        "postcode": "",
        "state": "",
        "country": "",
        "customer_account": null,
        "metadata": {}
    },
    "product_details": {
        "product_id": 1683881296184003,
        "product_name": "p",
        "short_code": "p",
        "authorization_method": "license-key",
        "metadata": {}
    },
    "metadata": {},
    "device_id": 1698747388694869,
    "is_borrowed": false,
    "borrowed_until": null,
    "is_expired": false,
    "version": "",
    "installation_file": "",
    "release_date": "",
    "hash_md5": "",
    "requires_version": "",
    "environment": "",
    "eula_link": "",
    "release_notes_link": "",
    "size": "",
    "channel": "",
    "license_signature": ""
}
﻿
Subscription
JSON
{
    "id": 1698747695129889,
    "order_store_id": "fcfb946fe4a648c7abb66dba5ef08f79",
    "license_active": true,
    "license_enabled": true,
    "license_type": "subscription",
    "license_key": "H4U2-NSM2-9HAJ-X7ZD",
    "is_trial": false,
    "validity_period": "2025-10-31T00:00:00.000Z",
    "maintenance_period": null,
    "allow_grace_period": false,
    "grace_period": 1,
    "max_activations": 1,
    "allow_unlimited_activations": false,
    "times_activated": 1,
    "start_date": null,
    "transfer_count": 0,
    "max_transfers": 0,
    "allow_overages": false,
    "max_overages": 0,
    "is_floating_cloud": false,
    "is_floating": false,
    "floating_timeout": 5,
    "can_borrow": false,
    "max_borrow_time": 0,
    "prevent_vm": false,
    "custom_fields": [
        {
            "name": "skr",
            "data_type": null,
            "value": "222"
        },
        {
            "name": "1",
            "data_type": null,
            "value": "1"
        }
    ],
    "product_features": [],
    "customer": {
        "email": "",
        "company_name": "",
        "reference": "",
        "phone": "",
        "first_name": "",
        "last_name": "",
        "city": "",
        "postcode": "",
        "state": "",
        "country": "",
        "customer_account": null,
        "metadata": {}
    },
    "product_details": {
        "product_id": 1683881296184003,
        "product_name": "p",
        "short_code": "p",
        "authorization_method": "license-key",
        "metadata": {}
    },
    "metadata": {},
    "device_id": 1698747726688099,
    "is_borrowed": false,
    "borrowed_until": null,
    "is_expired": false,
    "version": "",
    "installation_file": "",
    "release_date": "",
    "hash_md5": "",
    "requires_version": "",
    "environment": "",
    "eula_link": "",
    "release_notes_link": "",
    "size": "",
    "channel": "",
    "license_signature": ""
}
{
    "id": 1698747695129889,
    "order_store_id": "fcfb946fe4a648c7abb66dba5ef08f79",
    "license_active": true,
    "license_enabled": true,
    "license_type": "subscription",
    "license_key": "H4U2-NSM2-9HAJ-X7ZD",
    "is_trial": false,
    "validity_period": "2025-10-31T00:00:00.000Z",
    "maintenance_period": null,
    "allow_grace_period": false,
    "grace_period": 1,
    "max_activations": 1,
    "allow_unlimited_activations": false,
    "times_activated": 1,
    "start_date": null,
    "transfer_count": 0,
    "max_transfers": 0,
    "allow_overages": false,
    "max_overages": 0,
    "is_floating_cloud": false,
    "is_floating": false,
    "floating_timeout": 5,
    "can_borrow": false,
    "max_borrow_time": 0,
    "prevent_vm": false,
    "custom_fields": [
        {
            "name": "skr",
            "data_type": null,
            "value": "222"
        },
        {
            "name": "1",
            "data_type": null,
            "value": "1"
        }
    ],
    "product_features": [],
    "customer": {
        "email": "",
        "company_name": "",
        "reference": "",
        "phone": "",
        "first_name": "",
        "last_name": "",
        "city": "",
        "postcode": "",
        "state": "",
        "country": "",
        "customer_account": null,
        "metadata": {}
    },
    "product_details": {
        "product_id": 1683881296184003,
        "product_name": "p",
        "short_code": "p",
        "authorization_method": "license-key",
        "metadata": {}
    },
    "metadata": {},
    "device_id": 1698747726688099,
    "is_borrowed": false,
    "borrowed_until": null,
    "is_expired": false,
    "version": "",
    "installation_file": "",
    "release_date": "",
    "hash_md5": "",
    "requires_version": "",
    "environment": "",
    "eula_link": "",
    "release_notes_link": "",
    "size": "",
    "channel": "",
    "license_signature": ""
}
﻿
Optional Query Parametars
Adding bolean include_expired_features query parametar will return additional fields in response.
List of exceptions
missing_headers (400): Some headers are missing
unknown_product (400): Provided product was not found
license_not_found (400): License with the provided license user not found
license_not_enabled (400): The license is not enabled
license_not_active (400): The license is not active
device_not_found (400): An active device matching the hardware_id not found
blacklisted (400): This device is blacklisted
license_not_enough_consumptions (400): Not enough consumptions left
floating_not_available (400): No available slots for floating license
﻿
Updated 25 Sep 2024
Did this page help you?
License Deactivation Offline
License Feature Check