For the complete documentation index, see llms.txt. This page is also available as Markdown.

2.1.0

Release date: June 11, 2026

Overview

Facephi Finger Service 2.1.0 adds the operational metrics Endpoint used to report Fingerprint usage counters.

This Version provides:

  • Public Fingerprint extraction Endpoints and 1:1 authentication on the Facephi contract

  • Usage counter report via GET /api/v1/finger/metrics

  • Explicit documentation of the supported Fingerprint image formats for image-based requests: wsq, bmp, png, jpg, jp2

Included endpoints

Endpoint
Method
Purpose

/api/v1/finger/extract

POST

Generates a Fingerprint template from a public payload

/api/v1/finger/authenticate

POST

Executes Fingerprint 1:1 authentication

/api/v1/finger/metrics

GET

Reports Fingerprint usage counters

/api/v1/finger/version

GET

Service Version and License status

/api/v1/finger/health

GET

Service health and availability

/api/v1/finger/config

GET/POST

Gets or updates the runtime configuration

Migration notes

  • Customers who need operational visibility can start consuming the Endpoint /metrics.

  • Continue relying solely on the documented public fields; internal processing details remain abstracted.

Deployment

Requirements

Component
Requirement

Operating system

Linux x86_64

License

Valid Facephi License file

Docker

Recommended for deployment

Known limitations

  • Fingerprint operation endpoints are only available when the service runs in the role master.

  • Dynamic configuration updates are applied in memory and are not persisted automatically.

  • Some configuration values require a restart to take full effect (port, number_of_threads).

Documentation

Support

For Technical Support, contact your Facephi representative.

Last updated