FIfireblocks
Trading

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).

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

Request

Path parameters

orderIdstring required

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

Response

Order requirement details

requirementIdstring required

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

dueBystring date-time

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

requiredDatastring 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 response

{
  "requirementId": "info_7c1f9b2e4a6d",
  "dueBy": "2024-01-15T10:35:00.000Z",
  "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"
      ]
    }
  ]
}

Changes

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