DocumentFieldResponseDto

Endpoints · All schemas

Field	Required	Description
candidates	Yes	Values the text suggests, most likely first
confidence	Yes	Recognition confidence of the supporting line (0-1)
editId	Yes	ID of the owner’s decision about this field
evidenceChanged	Yes	The supporting text has since been read differently or is gone
field	Yes	See definition below
lineId	Yes	Recognized line supporting the value
region	Yes	See definition below
revision	Yes	Revision of the owner’s decision
status	Yes	See definition below
updatedAt	Yes	When the owner last decided
value	Yes	The suggested, confirmed or corrected value; null when dismissed

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: DocumentFieldCandidateDto, DocumentField, DocumentRegionDto, DocumentFieldStatus

{
  "properties": {
    "candidates": {
      "description": "Values the text suggests, most likely first",
      "items": {
        "$ref": "#/components/schemas/DocumentFieldCandidateDto"
      },
      "type": "array"
    },
    "confidence": {
      "description": "Recognition confidence of the supporting line (0-1)",
      "format": "double",
      "nullable": true,
      "type": "number"
    },
    "editId": {
      "description": "ID of the owner’s decision about this field",
      "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"
    },
    "evidenceChanged": {
      "description": "The supporting text has since been read differently or is gone",
      "type": "boolean"
    },
    "field": {
      "$ref": "#/components/schemas/DocumentField"
    },
    "lineId": {
      "description": "Recognized line supporting the value",
      "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"
    },
    "region": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DocumentRegionDto"
        }
      ],
      "nullable": true
    },
    "revision": {
      "description": "Revision of the owner’s decision",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "nullable": true,
      "type": "integer"
    },
    "status": {
      "$ref": "#/components/schemas/DocumentFieldStatus"
    },
    "updatedAt": {
      "description": "When the owner last decided",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "value": {
      "description": "The suggested, confirmed or corrected value; null when dismissed",
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "candidates",
    "confidence",
    "editId",
    "evidenceChanged",
    "field",
    "lineId",
    "region",
    "revision",
    "status",
    "updatedAt",
    "value"
  ],
  "type": "object"
}