File Uploads
Invofox supports various methods for uploading files depending on your specific integration needs and workflow requirements.
Supported File Types
Invofox accepts the following file formats:
- Images:
image/jpeg,image/png,image/tiff - PDFs:
application/pdf - Compressed Files:
application/zip
Note about ZIP files
Compressed files are processed through multiple upload endpoints only. We recommend uploading individual files when possible for better processing control.
Metadata Information
Invofox uses metadata associated with file uploads to:
- Identify which features to use (e.g., Splitter, Classifier)
- Include client-specific fields that won’t be processed by Invofox (
clientData)
Upload Parameters
The upload endpoints accept the following metadata parameters:
Available Parameters:
clientData(object) - Client-provided metadata that will be returned in API responses and webhook events
ClientData Field
The clientData field is particularly useful for:
- Internal reference tracking - Store your internal IDs, reference numbers, or metadata
- Webhook integration - This data will be returned in webhook notifications for easy correlation with your internal systems
- Information retrieval - Access your custom data when retrieving extracted document information through the API
Upload Methods
Choose the best upload method for your integration needs:
Process multiple files with independent error handling per file. Supports splitter functionality and compressed files. Files are processed asynchronously.
Process files from cloud storage or CDNs using publicly accessible URLs. Efficient for existing cloud workflows. Files are processed asynchronously.
Monitoring and Results
For tracking file reception and document generation, we recommend using webhooks. See Processing Tracking for event types and Webhook Implementation for setup and best practices.
For retrieving information about imports, files, and documents, use our API as described in Information Retrieval.
