Skip to navigation
TOC APIOrders

Upload a supporting document

Uploads or replaces a supporting document for a specific BOP requirement slot on an order. Idempotent — re-uploading replaces the previous file and resets the document status to uploaded. Max file size: 50 MB. Allowed MIME types: image/png, image/jpeg, application/pdf, text/csv (.csv files only).

Authentication

AuthorizationBearer
Token obtained via the login flow.

Path parameters

orderIdstringRequired
docIdstringRequired

Request

This endpoint expects a multipart form containing a file.
filefileRequired

The file to upload (PNG, JPEG, PDF, or CSV; max 50 MB).

Response

Document uploaded successfully.
idstring
orderIdstring
labelstring

Human-readable document label from the BOP document requirement.

requiredboolean
Whether this document is mandatory for this BOP category.
statusenum
Current upload and review status of this document slot.
Allowed values:
originalFilenamestring or nullOptional
contentTypestring or nullOptional
fileSizeByteslong or nullOptional
uploadedAtdatetime or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error