Face Verification

Compares the faces in two images and says whether they are the same person, with a similarity score and the threshold applied.

POST/v3/store/ekyc/face-verificationTry it

Price0.3 ICper request
Served12.5Mcalls

v2.0
Active

Input

OutputPOST /v3/store/ekyc/face-verification

duration: 2.1263949871063232
matched: true
message: successfully performed
score: 38
threshold: 37

Every field, under Response

Request

curl -X POST https://api.iapp.co.th/v3/store/ekyc/face-verification \
  -H "apikey: YOUR_API_KEY" \
  -F "file1=@selfie.jpg" \
  -F "file2=@id-photo.jpg"

Response

200OK. The fields are explained under Response.

{
    "duration": 2.1263949871063232,
    "matched": true,
    "message": "successfully performed",
    "score": 38.0,
    "threshold": 37
}

Request

multipart/form-data, two images per request, one face in each.

Headers

apikeystringrequired

Your API key, created under API Keys in the control panel.

Body

file1filerequired

The first face. JPEG, PNG, HEIC or HEIF, or Base64; at least 600 × 400 px, up to 2 MB.

file2filerequired

The second face, the same limits.

thresholdnumber

The score at or above which the faces match. Default 36, for 99.50% precision; 48 gives 99.95%, for a very low false-acceptance rate.

The legacy paths /face-verification, /face-verification/v2, /face2 and /face_compare answer at the same price.

Response

matchedboolean

Whether score reached threshold

scorenumber

Similarity, 0 to 2822; higher is more alike

thresholdinteger

The threshold used

durationmessage

Seconds; successfully performed

Status codes

Code	Meaning
413	An image is over 2 MB
415, 442	Unsupported file format
420	A required parameter is missing
423	No face found in an image
440	No file attached
441	Too many images
560	The server is busy; retry
561, 562	Processing or queue timeout

Face Verification

Request

Headers

Body

Response

Details

Measured

Limits

Data handling

Request​

Response​

Details​

Request

Response

Details