API reference
Explore the Bifense API.
The Bifense API provides five core endpoint families: compare, verify, identify, enroll, and video analysis. Each supports synchronous and asynchronous execution patterns.
Core concepts
These concepts apply across all API endpoints.
Authentication
Every API call requires tenant context plus an API key or JWT with the appropriate scope.
Requested analyses
Optional analyses such as demographics are explicitly requested through the requestedAnalyses parameter rather than implied by the endpoint.
Async status model
Long-running workflows use an async submission and polling pattern for consistent, non-blocking execution.
Rate limits and billing
Requests are metered against your plan limits. View your current usage and quotas in the developer console.
Endpoint families
Each family represents a distinct biometric workflow with its own set of routes.
/api/v1/compareCompare
Sample-to-sample face comparison.
Endpoints
POST /api/v1/compare
POST /api/v1/compare/async
GET /api/v1/compare/status/{requestId}
Key details
- Best for direct selfie-to-selfie or probe-to-reference image comparison.
- Supports optional liveness and optional requestedAnalyses such as demographics.
/api/v1/verifyVerify
Probe-to-claimed-subject verification.
Endpoints
POST /api/v1/verify
POST /api/v1/verify/async
GET /api/v1/verify/status/{requestId}
Key details
- Use when the caller already knows the claimed subject and wants a yes/no decision.
- Supports local reference verification and can be extended with document-based verification workflows.
/api/v1/identifyIdentify
Async-first 1:N identification against enrolled references.
Endpoints
POST /api/v1/identify
POST /api/v1/identify/async
GET /api/v1/identify/status/{requestId}
Key details
- Use when you need to search a gallery rather than verify a claimed identity.
- Large-scale identification workflows are available through enterprise plans.
/api/v1/enrollEnroll
Subject-centered biometric enrollment.
Endpoints
POST /api/v1/enroll
POST /api/v1/enroll/async
GET /api/v1/enroll/status/{requestId}
DELETE /api/v1/enroll/{customerId}
Key details
- Subject-centered design so additional modalities and IDV workflows fit the same model.
- Template extraction and reference-management details are available in the developer console.
/api/v1/video/analyze/asyncVideo Analyze
Bounded frame or short video-burst analysis.
Endpoints
POST /api/v1/video/analyze/async
GET /api/v1/video/analyze/status/{requestId}
Key details
- Accepts short frame batches for quality, liveness, and demographics analysis.
- Analyses are explicitly requested through requestedAnalyses and options.