Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# License activation

The activation of a license is required prior to use any module of this SDK.

## License manager (Windows only)

On windows the graphical License Manager application may also be used to activate licenses. Please refer to the License Manager user’s guide for more details.

Please note that on windows, and windows only, you can lock your license on a USB device.

## Command-line interface

A command-line activation software is available in the activation/cli-tool directory.

For example on linux x64:

    cd activation/cli-tool/linux/x64
    chmod +x id3LicenseActivationCLI
    ./id3LicenseActivationCLI --help

Several options are possible to activate a license. See License activation options for details.

Activation with a serial number:

    id3LicenseActivationCLI.exe --activate .\data\id3Document.lic --serialkey="XXXX-XXXX-XXXX-XXXX"

Activation with an activation key:

    id3LicenseActivationCLI.exe --activate .\data\id3Document.lic --activationkey="email-XXXXXXXX-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

Activation with credentials:

    id3LicenseActivationCLI.exe --activate .\data\id3Document.lic --login="login@domain.com" --password="myPassword" --reference="XXXXXXXX"

## Programmatic activation

It is generally preferred to activate the license programmatically within your application. See License handling in the Usage section for details.

Note

On mobile devices, the License hardware code is linked to the application itself, so programmatic activation is the only way to activate a license in this case.

## License activation options

The following license activation options are available:

- Serial number: A unique key in the format `XXXX-XXXX-XXXX-XXXX` allowing a single activation.

- Activation key: A unique key in the format `email-XXXXXXXX-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX` allowing multiple activations on multiple devices.

- Credentials: Customer login/password and reference number of the product to be activated.

Important

An internet connection is required to complete the activation procedure. Unless the `Online` option is enabled, once the license is activated, the internet is no longer required.

Note

During the activation process, the SDK license is linked to a unique hardware identifier. See License hardware code for details.

## See also

- License handling

- License hardware code