Skip to content

Face2Face

The overview describes the common field interpretation rules, failure reasons, and full/light file formats.

Parent: face2face_result. Face comparison result; this block does not return the source photos.

Fields of face2face_result.

Fields marked “Required” are always present within this object. Other fields are included when a value is available; null is excluded from the response.

Field JSON type Purpose and conditions
result boolean Stored technology result: true means accepted, false means a negative result. May be absent before calculation; consider the status and the details below.
prediction string Numeric similarity score.
prediction_percent string prediction × 100, rounded to an integer and converted to a string without %. Returned with both non-zero and zero prediction; if the score is absent, both fields are excluded.
failure_reason object Failure reason, if recorded; see the structure.

The comparison service determines result. Do not replace it with your own threshold based on the rounded prediction_percent.

JSON examples

Fragments of the root response object, not complete responses. All values and URLs are illustrative. File formats follow the explanations on this page.

{
  "face2face_result": {
    "result": true,
    "prediction": "0.9700",
    "prediction_percent": "97"
  }
}