v1

latestOpenAPI 3.0.32026-07-14108241269.2 KB
Face Match v2

Face Match v2

Compares two face images and returns a match verdict with a similarity score and confidence band. The primary image (image1) is uploaded as a file. The comparison image may be supplied either as an uploaded file (image2) or as an HTTPS URL (image2_url). A non-matching pair still completes successfully (status: "success") with is_match: false.

Response contract: Every completed verification returns HTTP 200. A successful result returns status: "success" with error_code: null and a populated data object. A valid request with no matching record (or a business rejection) also returns HTTP 200 with status: "failed", a non-null error_code, and data: null. Do not treat HTTP 200 alone as success — always branch on status and inspect error_code. Authenticate with your X-Client-ID and X-API-KEY headers. Transport, auth, and validation problems use standard 4xx/5xx status codes.

post/v2/verify/face_match

Response

Face match completed. data.is_match carries the verdict.

statusstring required
messagestring nullable
error_codestring nullable
tranx_idstring nullable
timestampstring nullable