API Documentation

Facelify REST API Reference

Real-time face verification in under 200ms. Simple multipart REST API with secure x-api-key authentication.

<200ms

Average response time

Ultra-fast AWS Rekognition latency

99.9%

System uptime SLA

High availability REST infrastructure

2

Core endpoints

/register and /verify POST requests

Authentication

Pass your API key in the x-api-key request header on every request. Keys begin with fv_key_.

x-api-key: fv_key_sandbox_xxxxxxxxxxxxxxxx

API Endpoints

POST/api/v1/register

Register user reference photo at onboarding.

riderId string (required)
image file (JPEG/PNG)
POST/api/v1/verify

Verify live selfie against reference photo.

riderId string (required)
image file (Live Selfie)

Response Schema & Status Codes

200 OK Response

{
  "success": true,
  "verified": true,
  "similarity": 98.4,
  "riderId": "rider_102"
}

Common HTTP Status Codes

200 OKFace comparison completed
400 Bad RequestMissing riderId or image file
401 / 403Unauthorized or Low Balance

Code Examples

1Register reference photoShell
curl -X POST https://facelify.online/api/v1/register \
  -H "x-api-key: fv_key_your_api_key" \
  -F "riderId=rider_102" \
  -F "image=@/path/to/rider_doc.jpg"
2Verify live selfieShell
curl -X POST https://facelify.online/api/v1/verify \
  -H "x-api-key: fv_key_your_api_key" \
  -F "riderId=rider_102" \
  -F "image=@/path/to/live_selfie.jpg"