Start a chunked upload session
Start a chunked upload session for large files with no size limit.
When to use:
Use this endpoint instead of POST /v1/documents/submit when your files exceed 50 MB
or when you want resumable uploads that tolerate network interruptions.
Flow:
- Call this endpoint to create an upload session — get
sessionIdand per-filefileId,chunkSizeBytes,totalChunks - Upload each file in order using
PUT /v1/documents/upload/{sessionId}/files/{fileId}/chunks/{chunkIndex} - The last chunk automatically triggers compliance processing
- Optionally poll
GET /v1/documents/upload/{sessionId}/statusto track upload progress
Submission Modes (Mutually Exclusive):
Provide EITHER complianceReviewId (append to existing review)
OR businessEntityId (creates a new compliance review).
Cannot provide both or neither.
Framework and Control (Required for businessEntityId mode):
When using businessEntityId, also provide complianceFrameworkId and controlId
to specify which framework and control to use for the new review.
Session expiry:
Sessions expire after 24 hours. Expired sessions return 410 Gone on chunk upload.
Request fields:
files- Required. List of files to upload withfileNameandfileSize(bytes)complianceReviewId- Required if no businessEntityId. Existing review to append tobusinessEntityId- Required if no complianceReviewId. Entity ID for new reviewcomplianceFrameworkId- Required with businessEntityId. Framework for the new reviewcontrolId- Required with businessEntityId. Control for the new reviewisConsolidated- Optional. Merge all files into a single analysisselectedControlItemIds- Optional JSON array of control item ULIDs to target specific itemsselectedControlClusterIds- Optional JSON array of cluster ULIDs. All non-obsolete items within those clusters are included. Unioned withselectedControlItemIdsif both are provided.
Control Item Selection:
Use selectedControlClusterIds, selectedControlItemIds, or both to narrow the analysis scope:
- Both provided → union of cluster items and individual items
- Clusters only → all non-obsolete items within those clusters
- Items only → only those specific items
- Neither → all non-obsolete items across the entire control (default)
Invalid cluster IDs (not belonging to the active control) return 422.
Authorizations
API Key provided by Eve Admin Portal. Include this header in all authenticated requests.