Upload a file for an order requirement

post

https://api.fireblocks.io/v1/trading/orders/{orderId}/requirement/file

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.

Note: These endpoints are currently in beta and might be subject to changes.

If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to [email protected].

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.

Path Params

orderId

string

required

length ≥ 1

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

Body Params

Multipart body of POST /trading/orders/{orderId}/requirement/file. Uploads a single file as part of an order requirement response. Fireblocks encrypts and uploads each file individually to the underlying provider.

fileKey

string

required

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

file

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.

Headers

Idempotency-Key

string

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.

Responses

Language

URL

Loading…

Response

Choose an example:

*/*

application/json

202File accepted for processing.

400Bad request: unsupported file type, missing fileKey, malformed request, or validation failure.

401Unauthorized. Missing / invalid JWT token in Authorization header.

403Forbidden: insufficient permissions, disabled feature, or restricted access.

404Not found: the order does not exist.

409Conflict: the order exists but does not have an active order requirement (e.g., the order is not in AWAITING_INFORMATION).

429Rate limit exceeded: slow down and retry later.

5XXInternal error while processing the request.

defaultError Response