Documentation
Everything you need to integrate MxFace's face recognition, biometric, and computer vision APIs into your application — from your first API call to production best practices.
Use the following resources to learn how to use and implement face APIs in your software and application. In this user guide, you will find detailed descriptions and examples that describe implementation methods that you can use for enabling your application with face recognition technology with respect to various functionality like face detect, face compare, face attribute and face landmarks.
Face detection is a technique for detecting human faces in photographs and mapping them onto a high-precision rectangular grid. It may be used to lock and unlock the screen and apps, as well as a variety of other scenarios that need facial recognition. The location of specific places on the human face in relation to major facial characteristics can be used to enhance their beauty. This API can be used in a variety of ways such as face unlock, face clustering, and facial beautification.
DownloadFacial comparison detects and extracts essential facial traits, compares human faces with high precision, generates confidence scores, and evaluates if the same person appears in many photos. Face comparison technology that is cutting-edge categorises and handles photographs smartly. Face recognition is accurate thanks to an advanced picture recognition system, which also enables apps to provide an enhanced UX to user.
Download
Face attributes are biological traits that describe face characteristics with a high level of intrinsic stability and individual variation, making them valuable for identifying people. Gender, skin tone, age, and expression are all important factors.
DownloadThe important features on a human face in the input image are detected, and the coordinates of the key points (landmark points) that represent the facial contours are returned, providing input for future algorithms for beautification, facial modelling, and facial expression recognition.
Download
An iris recognition API taps into cutting-edge imaging technology to spot the unique patterns in each person's iris, making identity checks both secure and reliable. It's super useful for security checks, border control, and managing who gets in and where, ensuring swift and accurate identification. This way, only the right folks get access to restricted spaces or sensitive areas.
DownloadA fingerprint API offers mechanisms that allow you to add biometric authentication to your apps. It checks and matches fingerprints to confirm identities securely, helping with access control, tracking attendance, and managing financial transactions. This API boosts security by making sure that only authorized people can access sensitive data or areas.
Download
A people detection API utilizes machine learning algorithms to identify and locate humans in images or video streams. It can distinguish individuals in various poses and environments, providing real-time analytics for security, retail, and smart city applications. This technology supports enhanced surveillance, customer behavior analysis, and safety monitoring.
DownloadFollow these steps to go from sign-up to your first successful API response in just a few minutes.
Sign up for a free account to access the developer dashboard, API documentation, and sandbox environment.
From your dashboard, navigate to API Keys and generate a new key. Keep this key private — it authenticates every request you make.
Use our REST APIs directly, or install one of our platform SDKs (Face or Iris & Fingerprint) for faster integration.
Use the sandbox endpoint with a sample image to confirm your setup is working before moving to production traffic.
Every request to a MxFace API must include your API key in the request header. Requests without a valid key will be rejected with a 401 Unauthorized response.
curl -X POST https://api.mxface.ai/v2/face/detect \
-H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "url": "https://example.com/photo.jpg" }'The Face Detection endpoint is the simplest place to start. Send an image URL or base64-encoded image, and the API returns bounding boxes for every face found.
const response = await fetch("https://api.mxface.ai/v2/face/detect", {
method: "POST",
headers: {
"Ocp-Apim-Subscription-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({ url: imageUrl })
});
const data = await response.json();
console.log(data.Faces);All MxFace APIs return structured JSON. A typical Face Detection response includes an array of detected faces, each with a quality score and bounding box coordinates.
{
"Faces": [
{
"Quality": 99.0,
"FaceRectangle": {
"top": 175,
"left": 128,
"width": 226,
"height": 189
}
}
]
}Prefer not to call the REST API directly? Our SDKs handle image capture, quality checks, and network calls for you across Windows and Android.
1:1 face verification with live capture and anti-spoofing built in.
Unified biometric capture and matching for iris and fingerprint sensors.
MxFace APIs use standard HTTP status codes. Always check the status code before parsing the response body.
A few habits that meaningfully improve accuracy and reliability in production.
Check resolution and file size before upload to avoid unnecessary API calls and faster feedback for users.
Treat API keys like passwords — rotate them regularly and never expose them in client-side code.
Implement retry logic with backoff for 429 responses instead of failing immediately.
Every response includes a request ID — log it so our support team can quickly investigate any issue.
Create your free account and get your API key in minutes.