DocumentFieldCandidateDto

Endpoints · All schemas

Field	Required	Description
confidence	Yes	Recognition confidence of that line; null for a corrected line
lineId	Yes	Recognized line the value was read from
region	Yes	See definition below
value	Yes	The value as the text reads it

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: DocumentRegionDto

{
  "properties": {
    "confidence": {
      "description": "Recognition confidence of that line; null for a corrected line",
      "format": "double",
      "nullable": true,
      "type": "number"
    },
    "lineId": {
      "description": "Recognized line the value was read from",
      "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"
    },
    "region": {
      "$ref": "#/components/schemas/DocumentRegionDto"
    },
    "value": {
      "description": "The value as the text reads it",
      "type": "string"
    }
  },
  "required": [
    "confidence",
    "lineId",
    "region",
    "value"
  ],
  "type": "object"
}