Trading

Upload a file for an order requirement

Upload a single file (multipart/form-data) in response to an order requirement on an order that is in AWAITING_INFORMATION status. Call this endpoint once per required file.

Send fileKey (matching a fileKey from requiredFiles on the GET response) and the binary file. Its type must be one of the supported file formats. Fireblocks encrypts each file and uploads it individually to the underlying provider. The textual response is submitted separately via POST /trading/orders/{orderId}/requirement/data.

Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor.

For detailed information about error codes and troubleshooting, please refer to our API Error Codes documentation.

post/trading/orders/{orderId}/requirement/file

Request

Path parameters

orderIdstring required

The ID of the order to upload the order requirement file for.

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body multipart/form-data

fileKeystring required

Identifier of the required file this upload satisfies. Must match a fileKey from requiredFiles on the GET response.

filestring binary required

The binary file content. The file's type must be one of the supported OrderRequirementAllowedFileType values; the file name and type are derived from the uploaded part.

Example request

{
  "fileKey": "identity_document",
  "file": "<binary file content>"
}

Response

File accepted for processing.

Changes

No recorded changes to this operation across all 1 revision of this API.