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

Request

  • Base URL
    https://prod.idto.ai
  • URL
    https://prod.idto.ai/v2/verify/face_match
  • Auth
    API key in header X-Client-ID and API key in header X-API-KEY

Request body multipart/form-data

image1string binary required

Primary face image file (multipart upload). Required.

image2string binary nullable

Comparison face image file. Provide either image2 or image2_url.

image2_urlstring nullable

HTTPS URL of the comparison face image, used when image2 is not uploaded.

Response

Face match completed. data.is_match carries the verdict.

statusstring required
messagestring nullable
error_codestring nullable
tranx_idstring nullable
timestampstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.