Skip to navigation
Ingest ReferenceFiles

Upload single file by URL

Deprecated

Upload a single file by providing a URL from which the file will be downloaded and processed.

Allowed formats are:

  • Images: .jpeg, .jpg, .png, .tiff
  • PDFs: .pdf

The API accepts a single URL with optional metadata for processing.

Key Features:

  • Single file only (no batch processing)
  • No compression support
  • Splitter functionality is disabled
  • Pre-assigned DocumentId returned immediately

Important: Only HTTPS URLs are allowed for security reasons.

DEPRECATED: This endpoint will be removed. Use the batch upload endpoint (/upload-by-url) instead, which supports single or multiple URLs.

Authentication

x-api-keystring

API key authentication for programmatic access. Used by server-to-server integrations and API clients.

OR
x-access-tokenstring

Access token authentication for web users. Used by browser-based applications and authenticated user sessions.

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"

Single file URL to download and process.

Important: Only HTTPS URLs are allowed for security reasons. The file will be downloaded from this URL and processed as a single document without splitting.

Allowed formats:

  • Images: .jpeg, .jpg, .png, .tiff
  • PDFs: .pdf
filenamestringOptional
Optional filename for the document. If not provided, the filename will be extracted from the URL.
infoobjectOptional

Metadata and configuration for the single file being uploaded.

Single-File Context: All metadata in this field applies to the one file being uploaded. This is the simplest upload pattern - no dual-level metadata structure needed.

Available Settings:

  • company: Company ID for this file
  • type: Document type (e.g., ‘invoice’, ‘receipt’)
  • data: Processing data for this file
  • clientData: Client metadata for this file

Response

File queued for download and processing with pre-assigned DocumentId

accountIdstring
Account ID
environmentIdstring
Environment ID
importIdstring
Import ID for tracking the upload process
fileIdstring
File ID for the uploaded file
filenamestring
Original filename
documentIdstringDeprecated

Pre-assigned Document ID. DEPRECATED: This field will be removed. Instead, use webhooks to receive processing notifications, then retrieve documentIds from the file details endpoint.

Errors

400
Bad Request Error
404
Not Found Error