Embed the Rossum validation interface in your own application using redirect, popup, or iframe modes, giving users AI-powered data capture without leaving your system.

The Rossum validation interface can be embedded in a third-party application. This is useful when the out-of-the-box Rossum dashboards do not fit the use case and an existing document workflow solution is used, ranging from a document management system to a bookkeeping tool. The external application can embed the Rossum validation screen for a specific document on its core website, providing an uninterrupted user experience by integrating AI data capture into the existing tooling.

This allows users to benefit from the Rossum validation interface, including fast validation and feedback-driven AI learning, while continuing to use their existing application. No additional login is required. A document is shown directly to the user, who is returned to the application immediately after confirming it.

You can see the feature in action on your account in the Rossum Embedded Demo. Technically, it is implemented through the embedded mode API. A special create_embedded_url API call generates a unique URL that opens the validation interface for an individual document and calls an application-provided URL when the user finalizes the document.

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

• Redirect—This is the most natural approach and works similarly to a card payment gateway. The user’s window navigates from the application to Rossum document validation and then back to the application.
• Popup—When the user selects a button in the application, a pop-up window opens with document validation and closes when validation is finished. The application receives a JavaScript notification at that moment.
• IFrame—The Rossum document validation window is visually embedded in the application, either when the page loads or in response to a user action such as selecting a button.

Typical user workflows

From our experience, there are two usual workflows for embedding Rossum.

User opens documents in Rossum on demand

1. You have your own document dashboard in your application.
2. The user can open the selected document in Rossum by selecting a button.
3. The user is redirected to Rossum, or the document opens in Rossum in a new tab.
4. The user captures data from the document.
5. The user confirms the document and is taken back to your application.

User is taken to another document in Rossum after confirming

1. The user selects a button in your application that takes them to Rossum.
2. The user captures data from the document.
3. The user selects Confirm.
4. The user is taken to another document in Rossum.
5. Deleting or postponing a document takes the user back to your application.
6. The user is taken to your application if no other documents are available.

Best practices for embedding Rossum

Read about the best practices for embedding Rossum in your own application.

Note:

Embedded mode is available as an add-on

Rossum Embedded mode is available to all trial users but is a paid add-on for commercial use. Contact support@rossum.ai to discuss license upgrade options.