Licensing¶

IDLive® eKYC Toolkit is distributed in two build types available via the customer portal:

• Evaluation (Eval)
• Production (Prod)

Evaluation Builds¶

Evaluation builds include a built-in time-limited license. Each server component has its own expiration date, which you can find in the documentation for each component:

• IDLive Face Server 1.49.4
• IDLive Doc Server 3.3.0
• IAD Server 2.3.4
• IDFace Match Server 1.5.0

Production Builds¶

Production builds do not include a built-in license. Instead, a production license is issued individually for each customer. To obtain your license, please contact your assigned Success Manager.

Unlike evaluation licenses, the production license is installed centrally and must be accessible to all servers in the IDLive® eKYC Toolkit. This requires setting up a dedicated License Server.

Using the License Server in eKYC Components¶

To enable communication with the License Server, each eKYC server component (e.g. IDLive Face Server, IDLive Doc Server, IAD Server, IDFace Match Server) must be explicitly configured to use it.

This is done by setting the following environment variable when launching the corresponding Docker container:

--env HASP_NETWORK_LICENSE_SERVER=<license-server-address>

For example:

docker run -d \
  -e HASP_NETWORK_LICENSE_SERVER=<license-server-address> \
  561397722827.dkr.ecr.eu-west-1.amazonaws.com/facesdk/idface-server-all-prod:1.49.4

Replace <license-server-address> with the actual address of your License Server. If you're using a high-availability setup with a load balancer (e.g., NGINX), point this variable to the load balancer endpoint instead.

Installing the License Server¶

The license server is not containerized. It must be installed on a separate host or virtual machine.

If you are using the Production version, follow the steps below to install the License Server.

1. Download the License Server

   Download the license server archive aksusbd-10.13.1.tar.gz from the customer portal

2. Run the Installer

   Unpack the archive and run the installer:

   tar -xzf aksusbd-10.13.1.tar.gz
   cd aksusbd-10.13.1
   sudo ./dinst
   

   After installation, check that the required services are running:

   systemctl status hasplmd
   

Hardware requirements for the License Server¶

We recommend running the License Server on a small but reliable virtual machine. An instance with resources equivalent to t3.micro (e.g., 2 vCPU, 1 GB RAM) is sufficient for most deployments.

Configuring the License Server¶

Once the license server is installed and running, access its web interface — called Admin Control Center (ACC) — to complete the configuration.

By default, the ACC is only accessible from the local machine (via localhost):

http://localhost:1947

To access it remotely (e.g., from another server or workstation), additional configuration is required. You can enable it in one of the following ways:

Web Interface

1. Open http://localhost:1947 in your browser on the license server, or use SSH port forwarding to open it from your local machine.
2. Navigate to Configuration.
3. Check the option Allow Remote Access to ACC.
4. Press Submin.

Configuration File

1. Open the configuration file located at /etc/hasplm/hasplm.ini

2. Add or update the following section:

   [SERVER]
   accremote = 1
   

3. Restart the license server service:

   sudo systemctl restart hasplmd
   

Activate the License¶

To obtain and activate your production license using the Admin Control Center (ACC), follow the steps below.

1. Open the ACC Web Interface

   Open http://localhost:1947 in your browser on the license server, or use http://<license-server-ip>:1947 if remote access is enabled.

2. Generate the C2V File

   • Navigate to the Sentinel Keys section.
   • Click on Fingerprint.
   • Save the generated .c2v file to your local machine.

3. Send the generated .c2v file to your assigned Success Manager.

4. You will receive a .v2c license file in response.

5. Apply the V2C File

   • In the ACC web interface, go to Update/Attach.
   • Click Select File, select the received .v2c file.
   • Click Apply File to activate the license.

6. Verify Activation

   • In the ACC web interface, navigate to Sentinel Keys.
   • Ensure that the license is installed.

High Availability Deployment¶

The license server can be deployed in failover mode (multiple redundant instances) to ensure continued operation in case of individual server failure.

To achieve high availability, a load balancing mechanism should be placed in front of the license servers. This allows the components of the IDLive® eKYC Toolkit to interact with a single endpoint while requests are routed to healthy instances.

Several technologies can be used to implement this, including:

• NGINX
• HAProxy
• L7 cloud load balancers
• DNS-based round-robin

Below is an example configuration using NGINX.

NGINX Setup Example

You can run NGINX as a Docker container using the official image:

docker run -d \
  --name nginx-license-lb \
  -p 1947:1947 \
  -v /host/path/nginx.conf:/etc/nginx/nginx.conf:ro \
  nginx:stable

Configure nginx.conf file to include upstream and proxy settings that balance traffic between your license server instances, for example:

events {
    worker_connections 1024;
}

http {
    upstream license_servers {
            ip_hash;
        server license-server-1:1947;
        server license-server-2:1947;
    }

    server {
        listen 8080;
        location / {
            proxy_pass http://license_servers;
        }
    }
}

You can also install NGINX using a system package manager (e.g., apt, yum) if Docker is not available in your environment.