OCR Service

Facephi OCR Service is a REST API service written in modern C++ that uses Facephi OCR SDK as a powerful tool that helps read and verify identity documents and invoices offered by Facephi technology.

The service offers the endpoints /process and /process_multi, through which documents can be sent and information can be obtained from them.

JWT authentication can optionally be enabled when starting the service from config.json or through the environment variables FACEPHI_OCR_REST_AUTH_*. When JWT is enabled, GET /api/v1/version and GET /api/v1/health remain public, while protected endpoints require a valid JWT. JWT startup settings are never exposed via GET /api/v1/config nor can they be modified via POST /api/v1/config.

More information can be found in Technical specifications.

Supported image formats for identity documents:

• JPG

• PNG

• BMP

• HDR

Supported file format for invoices:

• PDF

The main distribution contains the following resources:

• Docker container. The container is available in Facephi's Docker repository and is based on Ubuntu 24.04. The container includes the service and all the dependencies needed to run it.

• Online documentation.

Flowchart

ocr-service flowchart: check license, run ocr, run interpreter