Getting Started with ARSA Face Recognition API: Your First API Call in 5 Minutes
Quick start guide for ARSA Face Recognition API — create an account, get your API key, and make your first face recognition call in minutes.
Prerequisites
Step 1: Get Your API Key
Step 2: Detect and Analyze a Face
The simplest call — detect faces and get age, gender, and liveness:
curl -X POST "https://faceapi.arsa.technology/api/v1/face_analytics" \-H "x-key-secret: YOUR_API_KEY" \
-F "face_image=@photo.jpg"
Response:
{
"status": "success",
"face_count": 1,
"faces": [{
"bbox": {"x1": 0.12, "y1": 0.08, "x2": 0.45, "y2": 0.52},
"passive_liveness": {"is_real_face": true, "liveness_probability": 0.97},
"age": 28.7,
"gender": "female",
"gender_probability": 0.88
}]
}
Step 3: Register a Face
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=@john.jpg"
Step 4: Recognize a Face
curl -X POST "https://faceapi.arsa.technology/api/v1/face_recognition/recognize_face" \-H "x-key-secret: YOUR_API_KEY" \
-F "face_image=@unknown.jpg"
Step 5: Compare Two Faces
curl -X POST "https://faceapi.arsa.technology/api/v1/face_recognition/validate_faces" \-H "x-key-secret: YOUR_API_KEY" \
-F "image1=@selfie.jpg" \
-F "image2=@id_photo.jpg"