Skip to content

Face SDK Licensing

In this article, we discuss the different kinds of licenses available for Regula Face SDK. Before reading further, make sure to explore the Architecture page to understand how the product works.

Licensing Types

Regula Face SDK Web Service is intended for on-premise server-side integration. For the SDK, the following licensing types are available:

  • OLxxxxx — the Online License works online and suits both the Mobile SDK and Web API on all supported platforms.
  • SLxxxxx — the Software License works offline with Web APIs on Windows only.
  • MLxxxxx — the Mobile License that works offline with the Mobile SDK in mobile OS.

The peculiarities of the licensing types are summed up in the table below:

Works offline
Works online
Mobile SDK usage
Web Component usage
Desktop/Web Server
Containerized solutions/Linux
Online automatic renewal
Offline manual renewal
Client-side comparison

Demo License

You can get an online demo license for all Regula products in one, valid for 30 days and 256 transactions. Go to the Regula Client Portal, create an account, navigate to the My Licenses section, and download your free trial license.

OL: Online Licensing

  • Mobile applications, web services, web components
  • iOS, Android, Windows, Linux, containerized solutions, browsers
  • Connection to the Regula licensing service is mandatory
  • Instance-based or transaction-based licensing
  • Works online, Internet connection availability required

Instance-based license

This license type includes active and passive instances. Transactions are performed from active instances. Passive instances may be configured as a backup but load balancers should not send any load to them until active instances become not operational. Otherwise, they will be counted as active.

Each worker counts as an instance. So, a setup of 3 machines with 2 workers on each requires a license for 6 instances.

Transaction-based license

You can use as many active instances as you need to maintain the load. The number of workers is not limited, only the number of the process requests counts.

How it works

When you use an online license, the application or web service contacts the licensing service at (and backup via encrypted communication (HTTPS, port 443) and sends requests for validation. The licensing service processes the request and responds with OK if the license is eligible, and with ERROR if not for any reason.

On the start of a worker process (instance), the licensing service is contacted, and a registration request is sent. Each worker process works in a single-threaded model. The number of workers is limited by available hardware resources.

For example, you have 1 web service deployed with 4 workers configured. In this case, if 4 requests come at the same time, they are processed in parallel and we count the number of active instances as 4.

On Windows, there can be only one worker running.

In case the online license is transaction-based, each time the functionality is used, every /api/process call, the web service contacts the licensing service with a POST request. If the license is valid for this kind of request, the request gets logged, the OK response is provided, and the SDK returns the processing results.

In case the online license is instance/worker-based, heartbeats are monitored instead. Every hour the web service sends a heartbeat request to the licensing service providing the following information: license ID, session ID, IP address, product type and version used, and the timestamp. If the license is valid and the response is OK, the web service continues to perform. If the response is FAIL, the service stops returning processing results. Heartbeats continue and as soon as the license becomes valid again, the operation of the web service restores automatically. In case there is no Internet connection when the request is sent, the result is TIMEOUT.

If internet connection is lost, an instance-based license works 72 hours after that and then stops returning results. A transaction-based license without internet connection stops returning results immediately.

Development version token

With an online license for the production version of your app, you can get an additional token — a license for development environment so you could develop and test your application.

The development version token works almost the same way as the transaction-based one, but there is a difference. Every image submitted for processing is counted by calculating and storing its hash. There is a certain limit of images that can be processed with the development version license.

As such licenses are usually used for automatic tests on the same specific dataset of images, the same images can be processed an unlimited number of times while there is a limit to the number of unique images.

License renewal

The license is renewed automatically via contacting the licensing service and does not require the app recompilation/republishing.

SL: Software Licensing

  • Works offline
  • For Desktop/Web Service on Windows only

How it works

A license token is an encrypted file that you should put to a specific folder for the SDK to work. The license key is generated based on the .sysinfo file.

The .sysinfo file contains a set of programmatic and hardware identifiers (for example, the Windows serial number, motherboard serial number, MAC address, etc). The SDK checks the match of those identifiers as this info is also encrypted in the key.


If the target system does not contain the relevant information (the identifier is missing or was modified), the license key won’t allow the SDK to initiate and the Error message will appear.

To get a license, reach our sales team and send the .sysinfo file generated by the Regula Licensing application. To get the .sysinfo file, follow this guide.

License renewal

When the license period is about to expire, you receive a notification from us and an offer to get a new file and renew the license.

ML: Mobile Licensing

  • For mobile applications only
  • Works locally on a device, offline
  • Works for both native OS apps and cross-platform frameworks

How it works

An offline license file contains information about:

  • licensed platform for use (iOS, Android, can be both in one license)
  • licensed functionality
  • licensed period (with specific expiration date)

The license file must be provided when the product is launched. If it matches the environment, everything will work for the licensed period until the expiration date.

Next Steps

Now, when you have selected the license type, you can navigate to the Installation pages: