Upload files by URL | Invofox

Upload files by providing URLs from which files will be downloaded and processed asynchronously. Allowed formats are

images: .jpeg, .jpg, .png, .tiff
PDFs: .pdf

The API accepts an array of file URLs with optional metadata for processing.

Upload files by providing URLs from which files will be downloaded and processed asynchronously. Allowed formats are - images: .jpeg, .jpg, .png, .tiff - PDFs: .pdf The API accepts an array of file URLs with optional metadata for processing.

Authentication

x-api-keystring

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

x-access-tokenstring

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

Request

This endpoint expects an object.

fileslist of objectsRequired

Array of file URLs to download and process.

Dual-Level Metadata Structure: Each file can have individual metadata (type, data, clientData) via the ‘info’ field within each FileUrlInfoDto. However, company can only be set at the batch level via the root ‘info’ field.

Per-File Metadata: Each file can specify its own document type, processing data, and client data. Batch Metadata: Company applies to ALL files in this request.

Array of file URLs to download and process. **Dual-Level Metadata Structure:** Each file can have individual metadata (type, data, clientData) via the 'info' field within each FileUrlInfoDto. However, company can only be set at the batch level via the root 'info' field. **Per-File Metadata:** Each file can specify its own document type, processing data, and client data. **Batch Metadata:** Company applies to ALL files in this request.

infoobjectOptional

Batch-level metadata that applies to ALL files in this request.

Important: This is where you set company context for the entire batch. Individual files cannot override company - this is a batch-level setting only.

Use this field for:

company: Company ID (applies to all files)
Global settings that affect all files

Individual file metadata like document type, processing data, and client data should be set in each file’s ‘info’ field.

Batch-level metadata that applies to ALL files in this request. **Important:** This is where you set company context for the entire batch. Individual files cannot override company - this is a batch-level setting only. **Use this field for:** - company: Company ID (applies to all files) - Global settings that affect all files **Individual file metadata** like document type, processing data, and client data should be set in each file's 'info' field.

Response

Files queued for download and processing

accountIdstring

Account ID

environmentIdstring

Environment ID

importIdstring

Import ID for tracking the upload process

fileslist of objects

Array of uploaded files information

1	curl -X POST https://api.invofox.com/v1/ingest/by-url \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"files": [
6	{
7	"url": "https://example.com/invoice.pdf",
8	"filename": "invoice-001.pdf",
9	"info": {
10	"type": "invoice",
11	"data": {
12	"companyActsLike": "issuer"
13	},
14	"clientData": {
15	"externalId": "INV-001"
16	}
17	}
18	},
19	{
20	"url": "https://example.com/receipt.pdf",
21	"filename": "receipt-001.pdf",
22	"info": {
23	"type": "receipt",
24	"data": {
25	"currency": "EUR"
26	},
27	"clientData": {
28	"externalId": "REC-001"
29	}
30	}
31	}
32	]
33	}'

1	{
2	"accountId": "66d5dc3afed4f8062c998439",
3	"environmentId": "66d5dc3afed4f8062c998440",
4	"importId": "66d5dc3afed4f8062c998441",
5	"files": [
6	{
7	"filename": "file.pdf",
8	"id": "66d721ec7edc0baa3794eec1",
9	"documentId": "66d71d63c9d0d2adc038b076"
10	}
11	]
12	}

Authentication

Request

Response

Errors