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

2.0.0

Release date: June 8, 2026

Overview

Facephi Finger Service 2.0.0 introduces the public Facephi contract for fingerprint extraction and 1:1 authentication.

This Version provides:

  • Public fingerprint operation endpoints based on the 2.0.0 contract

  • Removal of legacy public 1.x.x routes

  • Stricter request validation for fingerprint operations

  • Supported image formats for image-based fingerprint requests: wsq, bmp, png, jpg, jp2

Breaking Changes

  • POST /api/v1/finger/create-template has been replaced by POST /api/v1/finger/extract.

  • POST /api/v1/finger/verify has been replaced by POST /api/v1/finger/authenticate.

  • Fingerprint operation payloads are not compatible with 1.x.x clients.

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/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

  • Update client integrations to use /extract and /authenticate.

  • Update the request payloads to the public field names of Version 2.0.0.

  • Remove any dependency on legacy fields or on the availability of legacy routes.

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