Get File Data
Retrieve processed document data and check processing status. This endpoint supports both synchronous and asynchronous workflows, returning either the extracted data or processing status based on the job state.
Use Cases
Poll for processing status and results after submitting a job via the async process-file-async endpoint. Returns status updates during processing.
Fetch the actual extracted data using metadata from webhook events (fileId and extractionSchemaId from webhook payload).
Request Parameters
fileIdstringThe unique identifier of the file (from upload response or webhook event payload).
AuthorizationstringBearer token for authentication.
Response Types
This endpoint returns different response formats based on the processing state of the file.
Returned when an async job is currently being processed. Continue polling until status changes.
Returned when processing completed successfully. Contains the full extracted data including deployment information.
Returned when async processing failed due to an error. Check the error message for details.
Polling for Async Results
When using async processing, poll this endpoint to check status and retrieve results when processing completes.
💡 Polling Best Practices:
- • Use 5-10 second intervals to balance responsiveness and server load
- • Implement timeout logic to prevent infinite polling loops
- • Handle network errors gracefully with retry logic
- • Consider using webhooks for real-time notifications instead of polling
- • Store the jobId from PROCESSING responses for debugging purposes
Webhook Integration
Use this endpoint to fetch actual data when receiving webhook notifications. Webhook events contain metadata, and this endpoint retrieves the processed content.
Error Responses
Error responses you might encounter when calling this endpoint.