`GET /quotes/requirements`

Get the supporting-document policy for a destination currency before collecting recipient details or requesting a quote. No API key, customer, account, or amount is needed.

The rule comes from the same policy used for quote acceptance. Each priced quote returns its evaluated result as acceptance_requirements.files_required; read that field on the option you intend to accept.

Query parameters

Parameter	Required	Meaning
`currency`	Yes	Destination currency name, case-insensitive, or its numeric catalog ID.

curl 'https://orchestration.seismic.systems/api/v0/quotes/requirements?currency=BRL'

Response

For BRL:

{
  "currency": "BRL",
  "supporting_document": {
    "requirement": "conditional",
    "condition": {
      "field": "destination_amount",
      "operator": "gte",
      "value": "50000",
      "currency": "BRL"
    },
    "description": "Required when the destination amount is at least 50000 BRL."
  }
}

gte means greater than or equal to. value is an exact decimal string in the destination currency; compare it with decimal arithmetic. It is not a threshold on the source amount. When the source amount is fixed, exchange rates and fees can change whether the priced destination amount crosses the threshold.

For INR:

{
  "currency": "INR",
  "supporting_document": {
    "requirement": "required",
    "description": "At least one supporting document is required at any amount."
  }
}

CNY and GHS return the same required rule with their own currency. Other catalog currencies return not_required under the current policy.

For USD:

{
  "currency": "USD",
  "supporting_document": {
    "requirement": "not_required",
    "description": "No supporting document is required by the current payment policy. Additional documents may be requested during processing."
  },
  "route_conditions": [
    {
      "destination_rail": "swift",
      "beneficiary": "third_party",
      "description": "A payout over swift to a beneficiary other than the customer may require a supporting document at any amount, depending on how it is routed."
    }
  ]
}

route_conditions lists payout routes that can require a supporting document at any amount, on top of supporting_document, when the beneficiary is not the customer (third_party). Whether a priced quote takes such a route depends on how it is routed, so read its acceptance_requirements.files_required. The field is omitted when the currency has none.

`requirement`	Meaning
`required`	Collect at least one supporting document regardless of amount. No `condition` is present.
`conditional`	A `condition` describes when a document is required. Check the priced quote for the evaluated result.
`not_required`	No supporting document is required by the current payment policy. No `condition` is present.

Use the structured fields for application logic and description for display. Rules can change; check acceptance_requirements.files_required whenever you request a new quote. Additional documents may be requested during processing.

This endpoint does not establish customer approval or corridor availability. External fiat account requirements separately describe the fields needed to register a recipient bank account.

TypeScript

import {  } from "seismic-orchestration";
 
const  = new ({
  : "https://orchestration.seismic.systems/api",
});
const  = await ..("BRL");
const  = .;
 
if (. === "conditional") {
  .(.., ..);
}

Errors

400: the currency query parameter is missing.
404: the currency name or numeric ID is unknown, including an empty value.