Upload files | Invofox

Upload a file or a group of files of the same type (invoice, deliveryNote… or one of your custom types) to your environment. Each file is then processed asynchronously. Allowed formats are

images: .jpeg, .jpg, .png, .tiff
PDFs: .pdf
Compressed files: .zip

One of the parameters files or urls must be provided and can also be combined.

Upload a file or a group of files of the same type (invoice, deliveryNote... or one of your custom types) to your environment. Each file is then processed asynchronously. Allowed formats are - images: .jpeg, .jpg, .png, .tiff - PDFs: .pdf - Compressed files: .zip One of the parameters files or urls must be provided and can also be combined.

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

Upload files with optional URLs and metadata

filesfilesOptional

Files to upload (PDF or image)

urlslist of stringsOptionalDeprecated

DEPRECATED: Use the /v1/ingest/by-url endpoint instead for URL-based uploads.

Array of URLs from which files will be downloaded and processed. This field is maintained for backward compatibility but should not be used in new integrations.

infoobjectOptional

Information to map to the uploaded files in JSON format

Response

URL to upload created

accountIdstring

Account ID that the files were uploaded to

environmentIdstring

Environment ID that the files were uploaded to

importIdstring

Import ID that was registered

fileslist of objects

Array of uploaded files information

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

Authentication

Request

Response

Errors