DocumentResponseDto

Endpoints · All schemas

Field	Required	Description
assetId	Yes	string
canEdit	Yes	The caller owns the photo and may correct its text
fields	Yes	array
fieldsEnabled	Yes	Field suggestions are switched on
lines	Yes	array
recognition	Yes	Whether the photo can be read again; owner only
recognizedAt	Yes	When the text was last read

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: DocumentFieldResponseDto, DocumentLineDto, DocumentRecognitionDto

{
  "properties": {
    "assetId": {
      "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"
    },
    "canEdit": {
      "description": "The caller owns the photo and may correct its text",
      "type": "boolean"
    },
    "fields": {
      "items": {
        "$ref": "#/components/schemas/DocumentFieldResponseDto"
      },
      "type": "array"
    },
    "fieldsEnabled": {
      "description": "Field suggestions are switched on",
      "type": "boolean"
    },
    "lines": {
      "items": {
        "$ref": "#/components/schemas/DocumentLineDto"
      },
      "type": "array"
    },
    "recognition": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DocumentRecognitionDto"
        }
      ],
      "description": "Whether the photo can be read again; owner only",
      "nullable": true
    },
    "recognizedAt": {
      "description": "When the text was last read",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "assetId",
    "canEdit",
    "fields",
    "fieldsEnabled",
    "lines",
    "recognition",
    "recognizedAt"
  ],
  "type": "object"
}