Software Licensing

Zivid SDK contains certain premium features which require a valid software license. This comes in the form of a license file that has been cryptographically signed and shared by Zivid. You can then unlock premium features by installing the license file, with no further required actions.

Install License.yml

Get your license file through your Zivid contact. Download and install it by placing it in the following directory:

mkdir %LOCALAPPDATA%\Zivid\API
move %HOMEPATH%\Downloads\License.yml %LOCALAPPDATA%\Zivid\API\

mkdir --parents "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API
mv ~/Downloads/License.yml "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API/

You will now be able to use premium features in the API.

About License.yml

The License.yml file contains information about the software license in addition to serving as a license in itself. Below is an example of an (invalid) license.

__version__: 1
__signature__: "A3r/03qb7i1lh5VhJJN4jwUU2ehRtEm2yIx5w3gVFeJXDnWzN6pxXV8qLsxsza2dkuZnybQYlxzg/XIuHO63fg=="
License:
    CustomerInformation:
        AgreementID: __not_set__
        CompanyName: "Zivid AS"
        CustomerID: __not_set__
    Entitlements: []
    ExpiresAt: 2100-10-13T09:34:00Z
    ID: "EA5B9EBA-598D-455C-A7B9-626523468A95"
    IssuedAt: 2025-10-13T09:33:25Z
    Notes: __not_set__
    Type: development

The cryptographic signature at the top ensures that any modification to the file will render it invalid. Therefore, make sure to not modify the file after receiving it from Zivid.

In addition to the license key it has the following metadata:

  • Agreement ID: An optional identifier for the quote number

  • Company Name: Legal name of the company the license is issued to

  • Customer ID: An optional identifier for the customer ID as per Zivid's records

  • Entitlements: A list of features that the license unlocks

  • Expires at: The date and time in UTC that the license expires

  • ID: A unique identifier for the license

  • Issued at: The date and time in UTC that the license was generated

  • Notes: Optional notes or comments about the license

  • Type: The type of license (development, evaluation, commercial)