FaceEvidenceDto

Endpoints · All schemas

Field	Required	Description
assetId	Yes	The complete photo the face is in
box	Yes	Where the face is in the photo
faceId	Yes	The face, when it still exists

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "assetId": {
      "description": "The complete photo the face is in",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "box": {
      "description": "Where the face is in the photo",
      "nullable": true,
      "properties": {
        "height": {
          "description": "Height, as a fraction of the photo height",
          "format": "double",
          "type": "number"
        },
        "width": {
          "description": "Width, as a fraction of the photo width",
          "format": "double",
          "type": "number"
        },
        "x": {
          "description": "Left edge, as a fraction of the photo width",
          "format": "double",
          "type": "number"
        },
        "y": {
          "description": "Top edge, as a fraction of the photo height",
          "format": "double",
          "type": "number"
        }
      },
      "required": [
        "x",
        "y",
        "width",
        "height"
      ],
      "type": "object"
    },
    "faceId": {
      "description": "The face, when it still exists",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  },
  "required": [
    "assetId",
    "box",
    "faceId"
  ],
  "type": "object"
}