Moloni ON Logo WhiteGuidesAPI ReferenceExplorer
API Reference

OcrJobRead

object

Reads an OCR job

Provider details (provider, externalJobId, raw provider response) are intentionally never exposed.

Fields

NameTypeDescription
ocrJobIdString!

Please note that this value is a String (UUID) and not an Integer

statusOcrJobStatusEnum!
originalFileNameString!

Original file name of the scanned document

documentIdInt

Set once a draft document has been created from this job

documentDocumentRead

The draft document created from this job; null until documentId is set

msgString

Failure message (generic), when status is failed

documentErrors[String!]

Specific document-generation error messages (there can be more than one), shown beneath msg. Each is a source string the client translates; null when generation never failed.

suggestionsJSON

Review-time suggestions, set once a draft document is created (empty placeholder for now)

aiFilledDataJSON

What was pre-filled into the draft document, set once it is created (empty placeholder for now)

deletableBoolean!

True when the job can be deleted (i.e. it has finished — status ready or failed)

canRetryBoolean!

True when the job can be retried: it failed before OCR produced any result

canCreateDocumentBoolean!

True when a document can be created from this job: it failed after OCR produced a result

canDownloadFileBoolean!

True when the original scanned file can be downloaded: both its stored path and filename are present

createdAtDateTime
updatedAtDateTime

© 2026 Moloni ON

Tax Authority Certificate No. 3075