Rossum Developer Hub

Rossum Data Capture for Developers and Integrators

Welcome to the Rossum developer hub. You'll find comprehensive guides and documentation to help you implement Rossum as quickly as possible, as well as support if you get stuck.

Let's jump right in!

Developer Guides    API Reference    User Help Center

Rossum Embedded in Other Apps

Rossum validation interface can be embedded in a third-party app. This is useful when the out-of-the-box Rossum dashboards do not fit the usecase and an existing document workflow solution is used, ranging from a DMS to a bookkeeping tool. The external app can embed Rossum validation screen for a specific document on its core website and the user experience is completely undisrupted by meshing an AI data capture solution within the existing tooling.

That allows users to enjoy the Rossum validation interface (with its speedy validation and the feedback-driven AI learning) while keeping the app they use. No extra login is required, a document is directly shown to the user and on confirming it, the user is immediately returned to the app.

You can see the feature in action, on your account, in the Rossum Embedded Demo. Technically, it is implemented as the embedded mode API. A special start-embedded API call generates a unique URL that will open the validation interface for an individual document when accessed, and call back an app-provided URL when the document is finalized by the user.

In practice, distinct user experiences arise from three typical Rossum embedding scenarios:

  • Redirect - this is the most natural way, working similar to card payment gateways. The user's window is navigated from the app to Rossum document validation, then navigated back to the app.
  • Popup - upon a button press in the app, a popup window is opened with the document validation, and closed again when finished (with the app receiving a JavaScript notification at that moment).
  • IFrame - the Rossum document validation "window" is actually visually embedded within the app, either from the very page load or with the validation appearing on user action (e.g. a button push).

Updated 9 months ago

Rossum Embedded in Other Apps


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.