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 Regula Document Reader Web API operation.

How to change the service listening address/port?

The config file is saved under the following path:

  • C:\Program Files\Regula\Document Reader Web API\.env for the х64 version

  • C:\Program Files (x86)\Regula\Document Reader Web API\.env for the x86 version

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

By default, the service listening address/port is:

  • "0.0.0.0:8080" for HTTP

  • "0.0.0.0:443" for HTTPS

How to run the Web API service using HTTPS?

Follow the Security guide.

How to recognize multi-page documents?

You should submit both document pages within a single transaction as in the example below. Please, mark every separate page image with a different page index value. The transaction will be processed as usual. When the results are ready, the XML or JSON structure will contain a list with the results in accordance with the requested result type (for each page).

[
    {   "Base64ImageString": "base64 string",
        "Format": ".jpg",
        "LightIndex": 6,
        "PageIndex": 0
    },
    {   "Base64ImageString": "base64 string",
        "Format": ".jpg",
        "LightIndex": 6,
        "PageIndex": 1
     }
 ]

Where can I find logs?

You can find logs under the following directory:

C:\Program Files\Regula\Document Reader Web API\logs

The logs are turned on in the .env file of the service root: DOCREADER_PROCESS_RESULTS_LOG_PATH='logs/process/'

LOGS_ACCESS_CONSOLE="false" LOGS_ACCESS_FILE="true" LOGS_ACCESS_FILE_PATH='logs/access/document-reader-access.log'

LOGS_APP_CONSOLE="true" LOGS_APP_FILE="true" LOGS_APP_FILE_PATH='logs/app/document-reader-app.log'

Liveness/Readiness Probes

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.

Where can I find sample clients?

Please navigate to the Clients page.

What capabilities value do you use on api.regulaforensics.com?

The default capabilities value used on the demo website api.regulaforensics.com is 500. It includes MRZ, Visual Zone OCR, Document Type, Visual Graphics and Barcode Processing.

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.

Are there any requirements to image quality?

Yes, please find them on the Image Quality Requirements page.

Can I receive notifications about SDK releases?

Yes, you can subscribe to our newsletters.