---
title: "Perform facial comparison"
method: POST
path: "/api/ai/images/v2/facial-comparison"
---

# Perform facial comparison

`POST /api/ai/images/v2/facial-comparison`

## Request

- Base URL: `https://api.worqhat.com`
- URL: `https://api.worqhat.com/api/ai/images/v2/facial-comparison`
- Auth: API key in header `x-api-key` and API key in header `x-org-key`
- TypeScript: <https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints/docs/api/ai/images/v2/facial-comparison/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body `multipart/form-data`

- object
  - `source_image` string, binary: The source image for comparison
  - `target_image` string, binary: The target image for comparison

## Response `200`

Success

- ImageComparisonResponse
  - `id` string
  - `status` string
  - `timestamp` integer
  - `content` object
    - `matched_faces_count` integer
    - `unmatched_faces_count` integer
    - `matched_faces` MatchedFace[]
      - `similarity` number, float
      - `quality` FaceQuality
        - `brightness` number, float
        - `sharpness` number, float
      - `confidence` number, float
    - `unmatched_faces` UnmatchedFace[]
      - `confidence` number, float
      - `quality` FaceQuality
        - `brightness` number, float
        - `sharpness` number, float
  - `processing_count` integer

## Other responses

- `400`: Bad Request
- `401`: Unauthorized - Invalid API Key or Organization Key
- `404`: Not Found
- `406`: Not Acceptable - Invalid Content Type or Content not supported
- `500`: Internal Server Error

## Changes

- **2023-06-27** `a1044e79bd85`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints/changes/api/ai/images/v2/facial-comparison/post.md)

---

[API](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints.md) - [All operations](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints/revisions/a1044e79bd85?raw)