FaceVerify
FaceVerify API v1

API Reference

Real-time face comparison for delivery workflows. Two endpoints, one header, multipart form — production-ready in under an hour.

⏱
<200ms
Avg latency
✓
99.9%
Uptime SLA
#
2
Endpoints
Authentication

API key authentication

Pass your key via the x-api-key request header on every call. Keys are prefixed fv_key_ and scoped per environment. Never expose them client-side in production.

x-api-key: fv_key_xxxxxxxxxxxxxxxx
Endpoints
POST/api/v1/register

Store a user's reference face. Call once during onboarding.

Request · FormData
userIdstringUnique user identifier
imagefileKYC / reference photo
POST/api/v1/verify

Compare a live selfie against the stored reference face.

Request · FormData
userIdstringUser ID to look up
imagefileLive selfie from camera
Response schema
register200 OK
success
boolean
riderId
string
message
string
verify200 OK
verified
boolean
similarity
number
threshold
number
Error codes
400Bad Request

Missing userId or image field.

401Unauthorized

Invalid or missing x-api-key header.

404User Not Found

No reference face registered for this userId.

422No Face Detected

Uploaded image contains no detectable face.

500Internal Error

Server-side failure — contact support at hello@webappdigitalsolutions.com.

Code examples
1Register a userShell
curl -X POST https://api.faceverify.io/api/v1/register \
  -H "x-api-key: fv_key_your_api_key" \
  -F "riderId=rider_102" \
  -F "image=@/path/to/rider_doc.jpg"
2Verify user identityShell
curl -X POST https://api.faceverify.io/api/v1/verify \
  -H "x-api-key: fv_key_your_api_key" \
  -F "riderId=rider_102" \
  -F "image=@/path/to/live_selfie.jpg"

Integration tip

Register once per user during onboarding, then call verify whenever identity confirmation is needed. Both similarity and threshold are returned so you can build a custom confidence UI or auto-flag low-confidence matches for manual review.