Upgrade a mixed document

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

Use this endpoint for mixed PDF uploads when only that mixed document needs a higher processing tier and you want new uploads to continue following the Book's current class.

For single (non-mixed) documents, use the Upgrade a document endpoint. For Book-level class changes, use the Book Upgrades and Update Book endpoint.

Requirements

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

When to use this endpoint

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

Upgrade types

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

Mixed document upgrades are forward-only. You cannot downgrade 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 mixed_doc_uuid.

string

The universal unique identifier of the Document that will be upgraded. Mutually exclusive with mixed_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