Introduction

Welcome to the Ocrolus API reference

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

📘

JSON fields can be in any order!

Most Ocrolus endpoints return JSON-formatted data. JSON keys can be in any order, which means that the objects in the API Reference's example responses might be ordered differently than the ones you'll see in practice. This is perfectly normal.

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.

Unless otherwise stated, we only support North American documents at this time.

📘

HTTP status codes

While the Ocrolus 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. For more details about HTTP status codes, see HTTP status codes.


Did this page help you?