Skip to content

Frequently Asked Questions

Info

You can find solutions to common issues on the Troubleshooting page.

Where can I download the latest Web API version?

Please use the Regula Download Manager tool.

Note that the Regula Downloads Manager is only required for the download of the package and has no further impact on the Web API operation.

How to change the service listening address/port?

The config file is saved under the following path:

  • C:\Program Files\Regula\Face Processing Service\.env for the —Ö64 version

  • C:\Program Files (x86)\Regula\Face Processing Service\.env for the x86 version

To change the service listening address/port, you need to change the value: FACEAPI_BIND="0.0.0.0:41101"

By default, the service listening address/port is:

  • "0.0.0.0:41101" for HTTP

  • "8443" for HTTPS

How to run the Web API service using HTTPS?

Follow the Security guide.

Where can I find logs?

The logs saving is turned on and the storage type is indicated in the .env file of the service root through the FACEAPI_STORAGE_LOGS_DESTINATION variable. Find more info on the Settings page.

Liveness Probe

You can leverage the /api/ping endpoint for monitoring the container health and checking the availability of the container and the status of the license - expired or not.

Make sure to pick the interval between probes responsibly. A too low interval can flood the workers and affect the processing time. A too high interval can delay the identification of a malfunctioning container.

Readiness Probe

To determine if a container is ready to receive incoming network traffic and capable of handling requests, use the /api/readiness endpoint.

Where can I find sample clients?

Please navigate to the Clients page.

How many workers do I need?

To choose the optimal number of workers, see Performance considerations.

What about personal data and the licensing service?

The licensing service is created to manage the license keys, and this is its only purpose. The web service is customer-hosted which means that all personal data remains on the customer's servers and is not communicated back to Regula.

Can I connect to the licensing service via HTTP?

Yes. If you host the SDK in an isolated private environment, you can specify an HTTP proxy via the HTTPS_PROXY env variable. The proxy will be used by the web service to connect to the licensing service. If you use your own TSL certs, place them in the /etc/ssl/certs folder in Linux and docker envs.

Do not specify any protocol prefix in the proxy URL. Instead of HTTPS_PROXY=http(s)://host:port use HTTPS_PROXY=host:port

How to perform the licensing service health check?

To check if the service is available, use https://lic.regulaforensics.com/healthcheck or https://lic2.regulaforensics.com/healthcheck.

What if the SDK consumes too much memory?

To prevent excessive memory consumption, you can deinitialize the SDK after using it.