Initialise a chunked entity file upload

Use this for entity files above ~3.5 MB, where POST /entities/file/upload stops being reliable behind Lambda. Returns a sessionId and the server-preferred chunkSize (4 MB) — always split on the returned value rather than hardcoding it. Upload each part via /chunk (1-indexed partNumber) and finalise via /complete, which returns the file id. Attach that id as the FILE field value with POST /entities/{id}/data. entityId is optional; when sent, it must be an entity of your company within your scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The file name, and optionally the entity it belongs to.

string
required
number
metadata
object

Optional document metadata (validity dates, issuing country, document type, comment). The entity and uploader are recorded by the server and cannot be set here.

Responses

400

fileName is required, entityId is not a positive integer, or metadata is not an object

403

Caller is not a company admin

404

entityId is not an entity of your company within your scope

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json