Skip to main content
POST
Compare Faces
Submit two images and receive a similarity score plus a boolean isMatch decision. Typical use: comparing a selfie to the photo on a scanned ID.

Request

Headers

Body parameters

You can mix input modes within a single call — for example, send source as raw multipart bytes and target as a JSON S3 key in a multipart body. See the overview for the shared image rules.

Example request

Response

200 — Success

Error responses

Telling failure modes apart

The response shape lets you distinguish three distinct isMatch: false outcomes without a second API call: Surface a “retake your selfie” prompt when sourceFaceDetected is false, a “retake the ID photo” prompt when targetFaceDetected is false, and a “doesn’t match” outcome when both booleans are true but isMatch is false.