GET /ocr/{request_id}/images

Retrieves all OCR images of a document (page images) from the OCR service after processing has completed. The result is a byte array for a ZIP file which contains a PNG for each page for each document that was OCR’d.

Headers

Authorization (required) - Requires the standard authentication header used in the system.

Parameters

  • request_id Path Required

    the OCR request to return the document images. This is the OCR identifier returned from a successful POST /ocr response (request_id)

Code Sample 
curl -X GET -H "Accept: application/json"  
-H "Authorization: Bearer <token>" 
-H "Content-Type: application/json"  
-d "{}" 
https://<base_url>/api/v2/ocr/<request_id>/images
data = zdai.ocr.get_images(request_id = request.request_id)
Response Codes
  • 200 OK
    The response successfully returned
  • 400 Bad Request
    Request_id is missing.
  • 403 Forbidden
    Invalid or missing authentication token.
  • 404 Not Found
    The OCR request does not exist, has been cleaned up, or not finished.
  • 500 Internal Server Error
    Something went wrong unrelated to the users request or the OCR failed and there is an error message.

Response Data

  • Byte array for a ZIP file

    upon successful status retrieval, the byte array for a ZIP file will be returned

Need Help?

Couldn’t find the information you were looking for or need more assistance?

Contact Support