FaceCompareResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-face-compare-response-schema.json",
  "title": "FaceCompareResponse",
  "description": "Results of comparing/matching faces in an image",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudmersive-face-api-openapi.yml#/components/schemas/FaceCompareResponse",
  "type": "object",
  "properties": {
    "Successful": {
      "description": "True if the operation was successful, false otherwise",
      "type": "boolean"
    },
    "Faces": {
      "description": "Array of faces found in the input image",
      "type": "array",
      "items": {
        "$ref": "#/$defs/FaceMatch"
      }
    },
    "FaceCount": {
      "format": "int32",
      "description": "Number of faces found in the image",
      "type": "integer"
    },
    "ErrorDetails": {
      "description": "Details of any errors that occurred",
      "type": "string"
    }
  },
  "$defs": {
    "FaceMatch": {
      "description": "Location of one face in an image, along with match results",
      "type": "object",
      "properties": {
        "LeftX": {
          "format": "int32",
          "description": "X coordinate of the left side of the face",
          "type": "integer"
        },
        "TopY": {
          "format": "int32",
          "description": "Y coordinate of the top side of the face",
          "type": "integer"
        },
        "RightX": {
          "format": "int32",
          "description": "X coordinate of the right side of the face",
          "type": "integer"
        },
        "BottomY": {
          "format": "int32",
          "description": "Y coordinate of the bottom side of the face",
          "type": "integer"
        },
        "HighConfidenceMatch": {
          "description": "True if there is a high confidence match, false otherwise",
          "type": "boolean"
        },
        "MatchScore": {
          "format": "double",
          "description": "Match score from 0.0 to 1.0 with higher scores indicating a greater match; scores above 0.7 indicate a match",
          "type": "number"
        }
      }
    }
  }
}