Skip to main content
POST
/
v3
/
face-match
Face Match
curl --request POST \
  --url https://verification.didit.me/v3/face-match/ \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form user_image='@example-file' \
  --form ref_image='@example-file' \
  --form face_match_score_decline_threshold=30 \
  --form rotate_image=false \
  --form save_api_request=true \
  --form 'vendor_data=<string>'
{
  "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "face_match": {
    "status": "Approved",
    "score": 80,
    "user_image": {
      "entities": [
        {
          "age": 27.63,
          "bbox": [
            40,
            40,
            100,
            100
          ],
          "confidence": 0.717775046825409,
          "gender": "male"
        },
        {
          "age": 23.23,
          "bbox": [
            327,
            325,
            874,
            876
          ],
          "confidence": 0.797775046825409,
          "gender": "male"
        }
      ],
      "best_angle": 0
    },
    "ref_image": {
      "entities": [
        {
          "age": 22.16,
          "bbox": [
            156,
            234,
            679,
            898
          ],
          "confidence": 0.717775046825409,
          "gender": "male"
        }
      ],
      "best_angle": 0
    },
    "warnings": []
  },
  "created_at": "2025-05-01T13:11:07.977806Z"
}

Authorizations

x-api-key
string
header
required

Body

multipart/form-data
user_image
file
required

User's face image to be verified. Allowed formats: JPEG, PNG, WebP, TIFF. Maximum file size: 5MB.

ref_image
file
required

Reference image to compare against. Allowed formats: JPEG, PNG, WebP, TIFF. Maximum file size: 5MB.

face_match_score_decline_threshold
integer
default:30

Results with face match score below this will be declined. Must be between 0-100.

Required range: 0 <= x <= 100
rotate_image
boolean
default:false

If true, attempts to rotate the input images in 90-degree increments (0, 90, 180, 270) to ensure the detected face is upright before performing the face match. Note: This is only recommended if you are unsure about the orientation of the face.

save_api_request
boolean
default:true

Whether to save this API request. If true, then it will appear on the Manual Checks section in the Business Console.

vendor_data
string

A unique identifier for the vendor or user, such as a UUID or email. This field enables proper session tracking and user data aggregation across multiple verification sessions.

Response

request_id
string<uuid>
face_match
object
created_at
string<date-time>