POST/api/v1/face/identify

Face Identification at Scale

Enroll users once, identify them instantly. Our embedding-based identification stores compact base64 vectors in your own database — no vendor lock-in, no PII stored on our servers.

POST /api/v1/face/identify

REQUEST

200 OK
{
  "matched": true,
  "best_match": {
    "user_id": "emp_001",
    "distance": 0.29,
    "threshold": 0.40
  },
  "processing_time_ms": 310
}

Key Features

Everything you need from a production-ready Face Identification API.

Your Database

Embeddings are base64-encoded and stored in your own database. We never hold biometric data.

Compact Vectors

Combined ArcFace + buffalo_l embeddings average ~5KB per user — 1,000 users fits in 5MB.

Sub-Second Match

Send a probe image and your candidates array. Get the best match in under a second.

Confidence Ranking

Returns the best match with user_id, distance, and threshold for easy integration.

How it works

Integrate in minutes with our developer-friendly REST API.

01

Enroll users

POST each user photo to /face/enroll. Store the returned base64 embeddings in your DB.

02

Send a probe

POST a probe image + your stored candidates array to /face/identify.

03

Get the match

Receive matched: true/false, the best matching user_id, and the distance score.

Data Output

Fields You Can Extract

All data returned as structured JSON — map directly to your database schema.

matched
best_match.user_id
best_match.distance
best_match.threshold
processing_time_ms
response.json
{
  "matched": true,
  "best_match": {
    "user_id": "emp_001",
    "distance": 0.29,
    "threshold": 0.40
  },
  "processing_time_ms": 310
}

Mobile SDK

NO API KEY

Face Capture SDK

Capture a face image natively in your app and pass it to this endpoint. No API key needed for the capture itself.

Add to build.gradle.kts — Kotlin 2.0+:

Kotlin
dependencies {
    implementation("com.codelyticalhub:face-capture:1.0.0")
}
// settings.gradle.kts
repositories { mavenCentral() }

Manifest permission (runtime request handled by the SDK):

XML
<uses-permission android:name="android.permission.CAMERA" />

Quick start:

Kotlin
FaceCaptureSDK.register(this)  // in onCreate

FaceCaptureSDK.start(activity) { result ->
    when (result) {
        is FaceCaptureResult.Success -> {
            val file   = ImageUtils.bitmapToFile(context, result.bitmap)
            val base64 = ImageUtils.bitmapToBase64(result.bitmap)
            myBackend.callFaceGuardApi(file)  // never put API key in the app
        }
        FaceCaptureResult.Cancelled -> { }
        is FaceCaptureResult.Error  -> showError(result.message)
    }
}

⚠ Note

Never embed your FaceGuard API key in the app. Always proxy through your backend.

Ready to integrate Face Identification?

Create a free account. Get 50 test API requests instantly — no credit card required.