Upload an entity file through the API

Uploads an entity (location) document, such as a staffing chart or a workers' compensation policy, for an entity FILE field. The file streams through the API server, so only the API host needs to be reachable. The API rejects anything over 25 MB, but the deployed API runs behind AWS Lambda, whose request payload limit puts the practical ceiling far lower: above 3.5 MB use POST /entities/file/upload-chunked/init → /chunk → /complete, which uploads in 4 MB parts. Returns { id }. The upload does not write to any field: to attach the file, send that id as the FILE field value with POST /entities/{id}/data (for a FILES field, a comma-separated list of ids), or in the body of POST /entities when creating the entity. entityId is optional, so a file can be uploaded before the entity exists; 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, and optionally the entity it belongs to.

file
required
number
string

Optional JSON object of 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

No file provided, entityId is not a positive integer, or metadata is not a JSON 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