Welcome to the Ocrolus API Reference

The Ocrolus API is a simple and secure HTTP API that accepts JSON payloads for input parameters and returns actionable data in JSON format.

Whether you're new to the Ocrolus API or refreshing your knowledge, this is where you'll find the information you need to automatically process documents with Ocrolus.

We recommend that you pay particular attention to the various endpoints supported by our API, along with the input parameters and the different interaction modes of these endpoints.

📘

HTTP Status Codes

While the API uses HTTP transport, we do not currently leverage HTTP Status Codes to report error conditions outside of a limited set of site-wide issues. These are described in detail in the HTTP Status Codes section below.