Skip to main content
While a range of API endpoints drive the Affinda solution, uploading documents for processing (and receiving the response) is fundamental to the platform.

​
Submission and Retrieval Options

When integrating document data extraction (parsing), there are three primary ways to submit documents and retrieve the parsed data:
Explanation:
  • Users submit a document, and the API processes it immediately
  • User application waits and the request stays open (wait = true ) until parsing is complete
  • When finished, the API directly returns the parsed document data
Pros:
  • Simplest integration
  • Immediate retrieval of results after completion
  • Suitable for documents that need to be processed quickly
Cons:
  • Not suitable for large documents or high-volume scenarios
  • Can lead to timeouts for documents requiring lengthy processing
Ideal Use Case:
  • Interactive apps where quick, synchronous response times are critical
Explanation:
  • Users submit a document and receive an immediate acknowledgment (document ID)
  • User application periodically checks (polls) the API endpoint using repeated GET requests to determine when parsing is complete
  • Once processing finishes, user retrieves the parsed data.
Pros:
  • Avoids connection timeouts; ideal for longer or variable processing times
  • Better suited for handling multiple simultaneous document submissions
Cons:
  • Additional complexity with polling logic
  • Generates higher API call volume (frequent polling checks)
  • Slight delay between actual completion and data retrieval, depending on polling interval
Ideal Use Case:
  • High-volume scenarios, large documents, or batch processing jobs where exact completion timing isn’t critical.
Explanation:
  • Users submit a document, receiving an immediate acknowledgment
  • Rather than polling, your application receives a webhook (callback notification) directly when the document is ready for export
    • In some cases this will be when the document is finished parsing, but in other use cases this may be when the document has been validated
  • After receiving the webhook, your application retrieves the parsed data with a GET request.
Pros:
  • Most efficient asynchronous method—reduces unnecessary polling.
  • Lower overall API usage
  • Provides real-time notifications upon completion
Cons:
  • Slightly higher setup complexity (webhook listener infrastructure required)
Ideal Use Case:
  • Real-time workflows or event-driven architectures where timely data retrieval is essential, or API usage optimization is needed
  • Scenarios where the application must wait until the document has been fully validated before receiving results
See Webhooks for more information.

​
Request Body

The following parameters may be included in the API POST request to Affinda using the Upload a document for parsing endpoint. Note, all individual parameters are optional, however, one of the following must be specified:
  • File
  • URL
Documents should be uploaded to the relevant Workspace (and optionally documentType specified if the document type is known at upload).
⌘I