Compare a selfie with a reference portrait

Headers

• Idempotency-Keystring8–200 chars

  Reuse on retries (printable non-space ASCII). For 24 hours the same key and the same request return the saved answer and check id without a second charge; a different request under the key returns 409.

Request bodyapplication/jsonrequired

• thresholdnumber0.5–0.75default 0.5
• reference_idstring≤ 128 chars

  Your own id, echoed in the answer.

• sandbox_outcomestring

  Sandbox keys only: which test answer to return. No model runs and nothing is charged.

  One ofmatchno_matchno_face

• selfiestringrequired

  JPEG, PNG or WebP, at most 10 MB.

• referencestringrequired

  The trusted portrait (document photo or chip image).

Responses

• 200The answer.

  • check_idstringuuid
  • productstring
  • environmentstring | null
  • sandboxboolean
  • checked_atstringdate-time
  • reference_idstring
  • signed_resultstring

    The same answer as an ES256 JWS, verifiable with /.well-known/jwks.json.

  • decisionstring

    One ofMATCHNO_MATCHNO_FACE_IN_SELFIENO_FACE_IN_REFERENCE

  • matchboolean
  • scorenumber | null

    Similarity score, about 0 for different people.

  • thresholdnumber
• 400Invalid input.
• 401Missing, unknown or expired API key.
• 402The balance does not cover the check.
• 403The key lacks the product's scope, its IP allowlist refuses the caller, or (code production_not_allowed) the organization may not use production yet.
• 409The Idempotency-Key is in progress (Retry-After: 1) or was used with a different request.
• 413A file or the body is too large.
• 415A file is not of an accepted type (checked by its bytes, not its name), or the body is neither multipart nor JSON.
• 422An image could not be decoded. Not charged.
• 429More than 120 calls in a minute for this product.
• 503The check could not run on our side. Nothing was charged; retry later with the same Idempotency-Key.