API ReferenceOCR

Get OCR Response (Async)

Get the status and results of an asynchronous OCR job.

Path parameters

jobIdstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

This endpoint returns an object.
jobIdstring
statusenum

The status of the OCR job.

Allowed values:
linkedJobIdslist of stringsOptional

The IDs of any OCR jobs that are processing other subdocuments of the same document.

pageRangeobjectOptional

The start and end page numbers of the corresponding subdocument (zero-indexed, inclusive). If not provided, the document was not split during OCR.

dataobjectOptional

Errors