Skip to main content
Using Affinda in ‘Embedded Mode’ enables users to integrate Affinda’s document validation UI directly into their own applications, creating a seamless experience for end-users. This method is designed to keep users within your application ecosystem while leveraging Affinda’s powerful extraction and processing capabilities.
Processed documents and extracted data are rendered directly within your application, removing the need for users to log in to multiple platforms.
Delivers the benefits of a ‘human in the loop’ solution to ensure the data extracted is 100% accurate.
When using the validation UI, the data from these user corrections creates a feedback loop that improves model performance over time.
Data is processed and made available instantly for users.
Adjust the interface to align with your branding and user experience requirements.

​
How it works

  1. Within the API or webhook response from any documents sent to Affinda, we return a value called meta.reviewUrl
  2. This signed and authenticated URL can be embedded as an iFrame within your platform (or open as a new tab in the browser), and allow members of your team to validate the predicted data and add any additional data points
  3. Once a document is ‘Confirmed’, the validated data can be requested or, more commonly, sent via a webhook
  4. This data is ingested into your platform for downstream processing with full confidence in the accuracy

​
Implementation

For security reasons, each signed URL is valid for 60 minutes. We recommend that users treat the URL as ephemeral and fetch it on demand:
  1. Store only the Affinda document ID in your system, not the review URL.
  2. When a user needs to view a document, your backend requests a fresh review URL from Affinda (using GET / document) and returns it to the client.
  3. Embed that URL in an iframe in your application (or open it directly if preferred).
  4. Do not persist the URL anywhere durable; consider it single-use/short-lived.
Hygiene: avoid putting the URL in emails, analytics, or logs; pass it directly from your backend

​
Configuration Options

To customize the theme in embedded mode, get in contact with the Affinda team.
  • Light or dark mode
  • Background colour
  • Text colour
  • Primary colour (pink by default)
  • Error colour (red)
  • Warning colour (orange)
  • Info colour (blue)
  • Success colour (green)
  • Annotation colour (yellow)
  • Used for anything with rounded corners, eg., buttons, annotations, popovers
  • Font family (system font by default; can use any system font, Adobe Fonts, Google Fonts)
  • Base font size
  • Font weights (regular, medium, bold)
The following actions / capabilities can be enabled or disabled:
  • Confirm document
  • Collection selector
  • Export data
  • Filename
  • Tags
  • Warnings
Theming customisations are only available in Embedded Mode, not when using the main Affinda application.
⌘I