Skip to main content

Integration

How client applications talk to the Biometric Identification Service, and what they send and receive.

Interfaces​

The service communicates over a REST API – the Biometric Identification Service subset of the Video Processing Platform REST API. A Swagger web interface is available on the deployed instance for browsing and calling the endpoints. Watchlist management and identification are performed through the REST API.

For endpoints, parameters, and sample requests, see the REST API page.

Inputs and outputs​

You send a structured JSON request – carrying a base64-encoded image or a pre-extracted template – and receive well-defined JSON responses for identification, verification, and liveness requests; the same REST API manages identities (watchlists and members). The service accepts two kinds of input:

  • Images – captured by the client (for example on-device auto-capture); the service performs detection, quality assessment, and template extraction server-side. This is the primary, most broadly compatible path.
  • Templates – face/palm templates already extracted on the device by the SFE Toolkit, submitted directly for matching (for example via SearchByTemplate). Sending templates requires a compatible template version between the on-device SFE Toolkit and the service; otherwise submit images instead.