Get order requirement details for an order

Fetch order requirement details for an order that is in AWAITING_INFORMATION status.

The response includes requirementId and dueBy metadata, a requiredData JSON Schema (Draft-7) describing the shape of the data object expected on POST /trading/orders/{orderId}/requirement/data, and requiredFiles descriptors for any files the provider requires (uploaded via POST /trading/orders/{orderId}/requirement/file).

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 CSM@fireblocks.com.

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

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

GET

trading

orders

{orderId}

requirement

TypeScript

const response: Promise<FireblocksResponse<OrderRequirementDetails>> = fireblocks.tradingBeta.getOrderRequirements(tradingBetaApiGetOrderRequirementsRequest);

{
  "requirementId": "info_7c1f9b2e4a6d",
  "requiredData": "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"type\": \"object\",\n  \"required\": [\"sourceOfFunds\", \"purposeOfPayment\"],\n  \"properties\": {\n    \"sourceOfFunds\": {\n      \"type\": \"string\",\n      \"enum\": [\"SALARY\", \"SAVINGS\", \"INVESTMENT_RETURNS\", \"BUSINESS_INCOME\", \"OTHER\"]\n    },\n    \"purposeOfPayment\": {\n      \"type\": \"string\",\n      \"enum\": [\"BUSINESS_EXPENSES\", \"PERSONAL_EXPENSES\", \"INVESTMENT\", \"OTHER\"]\n    }\n  }\n}\n",
  "requiredFiles": [
    {
      "fileKey": "identity_document",
      "description": "A clear photo or scan of the account holder's government-issued ID.",
      "allowedFileTypes": [
        "PDF",
        "JPEG",
        "PNG"
      ]
    }
  ],
  "dueBy": "2024-01-15T10:35:00.000Z"
}

Path Parameters

orderId

string

required

The ID of the order for which the order requirement is issued.

Minimum string length: 1

Response

Order requirement details

Order requirement details for an order that is awaiting compliance requirements. Returned by GET /trading/orders/{orderId}/requirement.

requirementId

string

required

Unique identifier of the order requirement request as issued by the provider.

Example:

"info_7c1f9b2e4a6d"

requiredData

string

required

A JSON Schema (Draft-7) in string format describing the shape of the data object expected on the corresponding POST /trading/orders/{orderId}/requirement/data request. The schema is the contract: the client builds the data payload to match it, and SDKs can validate before sending. The string content is expected to be valid JSON (application/json).

Example:

"{\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"required\": [\"sourceOfFunds\", \"purposeOfPayment\"],\n \"properties\": {\n \"sourceOfFunds\": {\n \"type\": \"string\",\n \"enum\": [\"SALARY\", \"SAVINGS\", \"INVESTMENT_RETURNS\", \"BUSINESS_INCOME\", \"OTHER\"]\n },\n \"purposeOfPayment\": {\n \"type\": \"string\",\n \"enum\": [\"BUSINESS_EXPENSES\", \"PERSONAL_EXPENSES\", \"INVESTMENT\", \"OTHER\"]\n }\n }\n}\n"

requiredFiles

object[]

required

Descriptors for files the provider requires as part of the order requirement response. Empty when no files are required. Each entry's fileKey is used to correlate uploads on the corresponding upload request.

Show child attributes

Example:

[
  {
    "fileKey": "identity_document",
    "description": "A clear photo or scan of the account holder's government-issued ID.",
    "allowedFileTypes": ["PDF", "JPEG", "PNG"]
  }
]

dueBy

string<date-time>

ISO-8601 timestamp indicating when the order requirement submission is due.

Example:

"2024-01-15T10:35:00.000Z"

Submit a response to an order requirementSubmit the user's textual response to an order requirement on an order that is in `AWAITING_INFORMATION` status. The request body carries `data` — a free-form object conforming to the `requiredData` JSON Schema returned by the GET endpoint. Any required files are uploaded separately via `POST /trading/orders/{orderId}/requirement/file`. 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 CSM@fireblocks.com. 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](https://developers.fireblocks.com/reference/api-error-codes).

⌘I

TypeScript

const response: Promise<FireblocksResponse<OrderRequirementDetails>> = fireblocks.tradingBeta.getOrderRequirements(tradingBetaApiGetOrderRequirementsRequest);

{
  "requirementId": "info_7c1f9b2e4a6d",
  "requiredData": "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"type\": \"object\",\n  \"required\": [\"sourceOfFunds\", \"purposeOfPayment\"],\n  \"properties\": {\n    \"sourceOfFunds\": {\n      \"type\": \"string\",\n      \"enum\": [\"SALARY\", \"SAVINGS\", \"INVESTMENT_RETURNS\", \"BUSINESS_INCOME\", \"OTHER\"]\n    },\n    \"purposeOfPayment\": {\n      \"type\": \"string\",\n      \"enum\": [\"BUSINESS_EXPENSES\", \"PERSONAL_EXPENSES\", \"INVESTMENT\", \"OTHER\"]\n    }\n  }\n}\n",
  "requiredFiles": [
    {
      "fileKey": "identity_document",
      "description": "A clear photo or scan of the account holder's government-issued ID.",
      "allowedFileTypes": [
        "PDF",
        "JPEG",
        "PNG"
      ]
    }
  ],
  "dueBy": "2024-01-15T10:35:00.000Z"
}