Health check

Checks the license and, when it is valid, runs an active health check of the internal fingerprint processing components on every call, and updates the health snapshot that GET /api/v1/finger/metrics publishes.

• The response is always HTTP 200 once the service is initialized. message is Healthy when the license is valid and the check succeeded, and Unhealthy otherwise.

• When the license is not valid, the processing components are not checked and engine keeps the result of the previous check.

• On master nodes the check applies the retries configured in engine_max_retries and engine_retry_delay, so a failing check can take several seconds: take it into account when setting probe timeouts.

• It never requires a JWT.

get

Responses

200

Health status of the service.

application/json

messagestring · enumRequired

Healthy when the license is valid and the last health check succeeded; Unhealthy otherwise. The response is always HTTP 200: check message, license.valid and engine.healthy.

Example: HealthyPossible values:

initializedbooleanRequired

Always true once the service is initialized.

Example: true

400

The service is not initialized (Service not initialized).

application/json

get/api/v1/finger/health

GET /api/v1/finger/health HTTP/1.1
Host: 127.0.0.1:6982/
Accept: */*

{
  "message": "Healthy",
  "initialized": true,
  "license": {
    "valid": true,
    "statusCode": "LF_OK",
    "statusMessage": "The license is valid."
  },
  "engine": {
    "initialized": true,
    "healthy": true,
    "role": "master",
    "lastHealthKnown": true,
    "lastHealthCheckAt": "2026-09-30T10:20:30Z",
    "lastError": "",
    "servicesConfigured": [
      "Master",
      "FingerTC",
      "Verifier"
    ]
  }
}