Skip to main content
POST
Verify whether two images match

Authorizations

Authorization
string
header
required

Use your API key as a bearer token.

Headers

x-request-id
string<uuid>

Optional UUID used for request tracing. Use a new UUID for each logical request and preserve the echoed value when contacting support. The gateway forwards the normalized or generated UUID on every internal admission retry. Reusing a postpaid UUID returns 409 request_id_conflict rather than replaying a cached result; do not change IDs to bypass an uncertain outcome.

Body

img1
string
required

Base64 image payload, data URL, or (when an authenticated model-server integration explicitly enables it) a signed HTTPS Supabase Storage object URL from the configured exact-origin allowlist. The managed API requires a direct, non-redirecting JPEG, PNG, or WebP response from that URL. It rejects images that exceed the active byte, request-size, or decoded pixel safety limits before forwarding work to the model runtime; arbitrary remote URL fetching is never enabled globally.

img2
string
required

Base64 image payload, data URL, or (when an authenticated model-server integration explicitly enables it) a signed HTTPS Supabase Storage object URL from the configured exact-origin allowlist. The managed API requires a direct, non-redirecting JPEG, PNG, or WebP response from that URL. It rejects images that exceed the active byte, request-size, or decoded pixel safety limits before forwarding work to the model runtime; arbitrary remote URL fetching is never enabled globally.

model_name
string

Approved model name from the current allowlist. For /verify and /represent, omitted, blank, or overlong values are treated as absent and the gateway injects the active default model.

Maximum string length: 200
Example:

"Facenet"

detector_backend
string

Optional detector backend from the current allowlist. When the active detector misses a face, the service may retry configured fallback detectors before returning no_face_detected.

Example:

"opencv"

enforce_detection
boolean
default:true
align
boolean
default:true
normalization
string

Optional DeepFace normalization mode.

distance_metric
enum<string>
Available options:
cosine,
euclidean,
euclidean_l2
Example:

"cosine"

Response

Verification result

verified
boolean
required
distance
number
required
threshold
number
required
model
string
facial_areas
object
time
number