Face Match (1:1)
Compare two face images and determine whether they belong to the same individual. This is a synchronous endpoint — the match result is returned immediately in the response.
Endpoint
POST
{BASE_URL}/face/matchRequest Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| source_image | File | Yes | Reference face image (e.g., photo from an ID document or a known image) |
| target_image | File | Yes | Image to compare against the source (e.g., a live selfie or uploaded photo) |
Sample Request
bash
curl '{BASE_URL}/face/match' \
-H 'Authorization: Basic <base64_encoded_credentials>' \
-H 'Content-Type: multipart/form-data' \
-F 'source_image=@ID_PHOTO_PATH' \
-F 'target_image=@SELFIE_PATH'Response
json
{
"response": {
"confidence": 0.97,
"match_result": "matched",
"similarity_score": "97.4"
}
}Response Fields
| Field | Type | Required | Description |
|---|---|---|---|
| confidence | Number | No | Confidence score of the match result, between 0 and 1 |
| match_result | String | No | Outcome of the comparison — either 'matched' or 'not_matched' |
| similarity_score | String | No | Percentage-style similarity score between the two faces |
ℹNote: The match decision is based on the similarity score relative to a configurable threshold. Contact your account manager to adjust the threshold for your use case.