post
https://api.ocrolus.com/v1/document/upgrade
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
| Scenario | Use this endpoint? |
|---|---|
| An Instant document needs Complete accuracy | Yes - 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 Complete | No - use Update Book |
| The file is a mixed document | No - use Upgrade a mixed document |
Upgrade types
upgrade_type | Meaning |
|---|---|
INSTANT | Upgrade from Classify to Instant capture |
COMPLETE | Upgrade 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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…