Image groups

Image group is a term used for a group of images that can contain one or more images. The Ocrolus API also processes images, where as a user you can upload images of any supported file type. Ocrolus will classify the images for further document processing. The form types which we support for image classification can be found here, which include Tax forms, ID Proofs, Bank statements, Pay stub, and many more.

Upload images to Ocrolus

To upload images to Ocrolus, perform the following steps:

  1. Generate your API credentials as described in the Authentication section.
  2. Create a new Book to upload all the images.
  3. Upload the image files to the Book. Reference the book_pk from the response to the "create Book" call. This will ensure that the files are organized within the appropriate Book.
  4. Once uploaded, call Mark image group as complete to finalize the image group.


Image Formats

We currently support a wide range of image formats including:

  • JPEG
  • PNG
  • BMP
  • TIFF (Currently we only support single-image TIFF files)

Setting the form_type to BANK_ACCOUNT makes the invocation equivalent to uploading PDF bank statements, while setting it to any other form type makes the invocation equivalent to uploading PDF forms.

To see the complete list of supported form types, see forms directory.

Additional form types can be set up for organizations by request. Your Account Manager can explain the form types available for your organization. If you have any questions about form types, email us at [email protected].


Check for completion

While you can request results at any point, you will only receive data from documents with VERIFICATION_COMPLETE status.

In order to receive results from a case, poll for completion for documents in a Book. In this scenario, poll for Book status. Alternatively, configure a webhook to be notified when a document or Book is complete.

Extract results from Book

To extract the results from a Book: