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.

​
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

Theming customisations are only available in Embedded Mode, not when using the main Affinda application.