Real-time Live Facial Assessment
Center Face & Look Ahead
Biometric Verification Summary
API Keys Management
Generate New API Key
Active & Blocked API Keys
Developer REST API Code Examples
curl -X POST "http://localhost:8000/api/v1/verify" \
-H "X-API-Key: tg_face_verify_sk_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{
"sessionId": "CUSTOM_SESSION_101",
"idDocumentImage": "data:image/jpeg;base64,...",
"liveKeyframes": ["data:image/jpeg;base64,..."]
}'
Biometric REST API Reference
Enterprise-grade REST endpoints for Face Liveness Assessment, 1:1 Face Matching, and Combined Identity Verification with GPU acceleration.
Backend Pipeline Execution Flow
Below is the visual flowchart representing how client requests flow through Authentication, Ingress Rate-Limiting, GPU-Accelerated Liveness Pipeline, and 1:1 Geometric Procrustes & Deep Feature Match Pipeline.
Face Liveness Assessment API: Evaluates multi-spectral passive anti-spoofing (2D FFT Moiré spectrum, Laplacian sharpness, YCrCb chrominance) and 3D active head pose liveness (3D PnP Euler angles, 2D perspective asymmetry) across camera keyframes. Requires tg_face_liveness_... or tg_face_verify_... API key.
| Parameter | Type | Required | Description |
|---|---|---|---|
| liveKeyframes | List[String] | Required | Array of Base64 encoded JPEG/PNG live camera frames captured during head turn challenge. |
| sessionId | String | Optional | Custom tracking session identifier. Auto-generated if omitted. |
| challengeType | String | Optional | Challenge type prompt (default: "NONE"). |
curl -X POST "http://localhost:8000/api/v1/face-liveness" \
-H "X-API-Key: tg_face_liveness_sk_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{
"sessionId": "LIVENESS_SESSION_101",
"liveKeyframes": ["data:image/jpeg;base64,..."]
}'
1:1 Face Matching API: Performs direct 1:1 facial identity matching between reference photo ID and live face using SFace 128-D Deep Feature Embeddings, PyTorch SVD Rigid Procrustes shape fitting, and anthropometric ratios. Requires tg_face_match_... or tg_face_verify_... API key.
| Parameter | Type | Required | Description |
|---|---|---|---|
| idDocumentImage | String | Required | Base64 encoded reference ID document photo (JPEG, PNG, HEIC, HEIF, WEBP, BMP). |
| liveKeyframes | List[String] | Required | Base64 encoded live camera keyframes array. |
| sessionId | String | Optional | Custom tracking session identifier. |
curl -X POST "http://localhost:8000/api/v1/face-match" \
-H "X-API-Key: tg_face_match_sk_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{
"sessionId": "MATCH_SESSION_101",
"idDocumentImage": "data:image/jpeg;base64,...",
"liveKeyframes": ["data:image/jpeg;base64,..."]
}'
Combined Face Verification API: Executes both 1:1 Face Matching AND Multi-Spectral Face Liveness assessment in a single unified API request. Requires tg_face_verify_... API key.
curl -X POST "http://localhost:8000/api/v1/verify" \
-H "X-API-Key: tg_face_verify_sk_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{
"sessionId": "VERIFY_SESSION_101",
"idDocumentImage": "data:image/jpeg;base64,...",
"liveKeyframes": ["data:image/jpeg;base64,..."]
}'