Face Recognition

Register, recognize, and manage faces in your database.

POST/api/v1/face_recognition/register_face

Register a new face with a unique identifier. Upload up to 4 images for better accuracy.

Headers

NameRequiredDescription
x-key-secretYesYour API key
x-face-uidYesUnique identifier for the face

Body (multipart/form-data)

NameTypeRequired
face_imagefileYes
additional_face_image_0/1/2fileNo
cURL Example
curl -X POST "https://faceapi.arsa.technology/api/v1/face_recognition/register_face" \
  -H "x-key-secret: YOUR_API_KEY" \
  -H "x-face-uid: john_doe" \
  -F "face_image=@photo.jpg"
200 OK
{"status": "success", "message": "john_doe registered", "latency_ms": 245.32}
POST/api/v1/face_recognition/recognize_face

Detect and recognize faces against your registered database.

cURL
curl -X POST "https://faceapi.arsa.technology/api/v1/face_recognition/recognize_face" \
  -H "x-key-secret: YOUR_API_KEY" \
  -F "face_image=@photo.jpg"
200 OK
{
  "status": "success",
  "faces": [{
    "recognition_uidresult": "john_doe",
    "recognition_confidence": 0.89,
    "bbox": {"x1": 0.12, "y1": 0.08, "x2": 0.45, "y2": 0.52},
    "passive_liveness": {"is_real_face": true, "liveness_probability": 0.95}
  }],
  "latency_ms": 312.45
}
DELETE/api/v1/face_recognition/delete_face

Delete a registered face. Requires x-face-uid header.

GET/api/v1/face_recognition/view_db

View all registered face UIDs in your database.

200 OK
{"status": "success", "face_count": 3, "face_ids": ["john_doe", "jane_doe", "bob"]}
DELETE/api/v1/face_recognition/reset_db

Delete all registered faces. This action cannot be undone.