Skip to content

PersonMergeSuggestionDto

Endpoints · All schemas

FieldRequiredDescription
distanceYesFace embedding distance between the two people (lower is more similar)
personYesThe person being reviewed
personEvidenceYesThe reviewed person's reference face and its complete photo, or null when none may be shown
suggestionYesThe suggested match for that person
suggestionEvidenceYesThe suggested person's reference face and its complete photo, or null when none may be shown

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.

Field definitions: PersonResponseDto, FaceEvidenceDto

{
  "properties": {
    "distance": {
      "description": "Face embedding distance between the two people (lower is more similar)",
      "format": "double",
      "minimum": 0,
      "type": "number"
    },
    "person": {
      "$ref": "#/components/schemas/PersonResponseDto",
      "description": "The person being reviewed"
    },
    "personEvidence": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FaceEvidenceDto"
        }
      ],
      "description": "The reviewed person's reference face and its complete photo, or null when none may be shown",
      "nullable": true
    },
    "suggestion": {
      "$ref": "#/components/schemas/PersonResponseDto",
      "description": "The suggested match for that person"
    },
    "suggestionEvidence": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FaceEvidenceDto"
        }
      ],
      "description": "The suggested person's reference face and its complete photo, or null when none may be shown",
      "nullable": true
    }
  },
  "required": [
    "distance",
    "person",
    "personEvidence",
    "suggestion",
    "suggestionEvidence"
  ],
  "type": "object"
}