Upgrade a document

Change the processing type of a Document from Classify to Instant, or from Instant to Complete—without changing the Book’s book_class.

Use this endpoint when only some documents need a higher processing tier and you want new uploads to continue following the Book’s current class.

For Book-level class changes, use the Book Upgrades and Update Book endpoints. For mixed PDFs, use the Upgrade a mixed document endpoint.

Requirements

  • Document-level upgrades must be enabled for your organization. If not, contact your Ocrolus account manager.
  • The document must finish its current processing before you upgrade it.
  • Child documents that belong to a mixed document cannot be upgraded with this endpoint. Upgrade the mixed document instead.
  • If the Book is already Complete, or a Book upgrade already covers the same target, the document upgrade is rejected.
  • On success, the document re-enters processing under the new tier. Re-fetch Capture or Analyze data after verification completes.

When to use this endpoint

ScenarioUse this endpoint?
An Instant document needs Complete accuracyYes - upgrade_type: COMPLETE
A classified document needs Instant capture (Book class is INSTANT_CLASSIFY_ISO_CAPTURE)Yes - upgrade_type: INSTANT
The entire Book should move to CompleteNo - use Update Book
The file is a mixed documentNo - use Upgrade a mixed document

Upgrade types

upgrade_typeMeaning
INSTANTUpgrade from Classify to Instant capture
COMPLETEUpgrade from Classify or Instant to Complete

Document upgrades are forward-only. You cannot downgrade a document from Complete back to Instant.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

The PK of the Document that will be upgraded. Mutually exclusive with doc_uuid.

string

The universal unique identifier of the Document that will be upgraded. Mutually exclusive with doc_pk.

string
enum

The type of processing to upgrade the Document to.

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json