> ## Documentation Index > Fetch the complete documentation index at: https://v2.docs.conduit.financial/llms.txt > Use this file to discover all available pages before exploring further. # List required recipient fields > Returns recipient fields required for the requested order route before creating an order. ## OpenAPI ````yaml https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /orders/requirements openapi: 3.0.0 info: title: Conduit Sandbox API description: >- **Sandbox API** — clients integrate against this surface to exercise happy and unhappy paths without consuming real KYC/PSP credits or moving real money. Customer KYC, banking partners, and crypto custody are stubbed; org-level KYB runs against real providers. Simulation endpoints under `/v2/sandbox/*` drive specific scenarios. Internal and portal endpoints are excluded from this spec. version: '2.0' contact: {} servers: - url: https://api.sandbox.conduit.financial/v2 description: Sandbox - url: https://api.conduit.financial/v2 description: Production security: - api-key: [] tags: - name: Customers - name: Registered Addresses - name: Wallets - name: Wallet Signers - name: Signing Quorum - name: Virtual Accounts - name: Applications - name: Documents - name: Verifications - name: Signing Requests - name: Transactions - name: Payouts - name: Whitelist Recipients - name: Orders - name: RFIs - name: Webhook Endpoints - name: Webhook Deliveries - name: Webhook Event Types - name: Features - name: Customer Onboarding - name: Sandbox paths: /orders/requirements: get: tags: - Orders summary: List required recipient fields description: >- Returns recipient fields required for the requested order route before creating an order. operationId: OrdersController_getRequirements_v2 parameters: - name: sourceCode required: true in: query description: Source asset code (e.g. `USDC`, `USD`). schema: type: string enum: - USD - EUR - GBP - CHF - JPY - CAD - AUD - NZD - SGD - HKD - CNY - KRW - INR - BRL - MXN - ARS - CLP - COP - PEN - ZAR - NGN - KES - GHS - EGP - AED - SAR - ILS - TRY - PLN - CZK - HUF - SEK - NOK - DKK - THB - IDR - MYR - PHP - VND - TWD - USDC - USDT - DAI - EURC - PYUSD - BTC - ETH - SOL - TRX - name: sourceChain required: false in: query description: >- Source chain when the source asset is a crypto token (e.g. `ethereum`). Omitted for fiat sources. schema: type: string enum: - ethereum - base - solana - polygon - arbitrum - optimism - avalanche - tron - stellar - bsc - bitcoin - name: destinationCode required: true in: query description: Destination asset code (e.g. `USD`, `USDC`). schema: type: string enum: - USD - EUR - GBP - CHF - JPY - CAD - AUD - NZD - SGD - HKD - CNY - KRW - INR - BRL - MXN - ARS - CLP - COP - PEN - ZAR - NGN - KES - GHS - EGP - AED - SAR - ILS - TRY - PLN - CZK - HUF - SEK - NOK - DKK - THB - IDR - MYR - PHP - VND - TWD - USDC - USDT - DAI - EURC - PYUSD - BTC - ETH - SOL - TRX - name: destinationChain required: false in: query description: >- Destination chain when the destination asset is a crypto token. Omitted for fiat destinations. schema: type: string enum: - ethereum - base - solana - polygon - arbitrum - optimism - avalanche - tron - stellar - bsc - bitcoin - name: destinationCountry required: false in: query description: >- Beneficiary country ISO 3166-1 alpha-2 or alpha-3 code. Required when the destination is a fiat bank rail; informational only — requirements are selected by rail (domestic rails always target a US account; `swift` is country-agnostic). schema: type: string - name: paymentRail required: false in: query description: >- Payment rail for the outbound leg when applicable. Conduit may resolve this server-side when unambiguous. Input is case-insensitive (`fedwire` and `FEDWIRE` both work); the documented wire value is lowercase (`fedwire`). schema: type: string enum: - rtp - fedwire - ach - swift - fednow - name: recipientType required: false in: query description: Whether the recipient is an individual or a business. schema: type: string enum: - individual - business - name: recipientRail required: false in: query description: >- Set to `crypto` to discover the fields for a crypto autoPayout recipient (an ONRAMP chains a crypto Withdrawal to an on-chain address). `crypto` is the only accepted value — fiat rails are derived from the fiat dimensions, which are mutually exclusive with it (`destinationCountry`/`paymentRail`/`recipientType`). Input is case-insensitive; the documented wire value is lowercase (`crypto`). schema: type: string enum: - crypto responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/RecipientRequirementsResponseDto' '400': description: >- **INVALID_OID_FORMAT**: A path or query parameter expected a valid object identifier but received a value that does not match the expected format. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorDto' example: type: INVALID_OID_FORMAT title: Invalid Object ID Format status: 400 detail: >- A path or query parameter expected a valid object identifier but received a value that does not match the expected format. resolution: >- Verify that all IDs in the request URL and query parameters are correctly formatted. IDs are typically prefixed strings like 'cus_...', 'app_...', or 'doc_...'. docs: https://conduit-v2.mintlify.app/errors#invalid-oid-format instance: /v2/... correlationId: req_a1b2c3d4 timestamp: '2026-01-15T09:30:00.000Z' '401': description: >- **API_KEY_MISSING**: The request did not include an API key. All API requests must be authenticated. **API_KEY_INVALID**: The provided API key is not recognized or has been revoked. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailDto' example: type: API_KEY_MISSING title: API Key Missing status: 401 detail: >- The request did not include an API key. All API requests must be authenticated. resolution: >- Include your API key in the 'x-api-key' header with every request. docs: https://conduit-v2.mintlify.app/errors#api-key-missing instance: /v2/... correlationId: req_a1b2c3d4 timestamp: '2026-01-15T09:30:00.000Z' '422': description: >- **UNSUPPORTED_PAIR**: The requested source and destination asset pair is not supported. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailDto' example: type: UNSUPPORTED_PAIR title: Unsupported Pair status: 422 detail: >- The requested source and destination asset pair is not supported. resolution: >- Check the configured trading pairs and submit a supported source/destination asset combination. docs: https://conduit-v2.mintlify.app/errors#unsupported-pair instance: /v2/... correlationId: req_a1b2c3d4 timestamp: '2026-01-15T09:30:00.000Z' '429': description: >- **RATE_LIMITED**: Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset on rate-limited route responses. content: application/json: schema: $ref: '#/components/schemas/RateLimitedErrorDto' example: type: RATE_LIMITED title: Rate Limited status: 429 detail: >- Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset on rate-limited route responses. resolution: >- Sleep until Retry-After seconds have elapsed, then retry. For sustained workloads exceeding the per-organization defaults, request a rate-limit increase through your support contact. docs: https://conduit-v2.mintlify.app/errors#rate-limited instance: /v2/... correlationId: req_a1b2c3d4 timestamp: '2026-01-15T09:30:00.000Z' retryAfterSeconds: 3 '500': description: >- **INTERNAL_ERROR**: An unexpected error occurred while processing your request. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailDto' example: type: INTERNAL_ERROR title: Internal Error status: 500 detail: An unexpected error occurred while processing your request. resolution: >- Retry the request after a brief delay. If the error persists, contact support and include the correlationId from the error response for investigation. docs: https://conduit-v2.mintlify.app/errors#internal-error instance: /v2/... correlationId: req_a1b2c3d4 timestamp: '2026-01-15T09:30:00.000Z' components: schemas: RecipientRequirementsResponseDto: type: object properties: destinationRecipient: type: string enum: - required - none reason: type: string fields: type: array items: type: object properties: name: type: string type: type: string enum: - string - number - boolean - date - email required: type: boolean minLength: type: number maxLength: type: number pattern: type: string enum: type: array items: type: string validator: type: string enum: - aba - iban requiredWhen: anyOf: - type: object properties: field: type: string equals: type: string required: - field - equals additionalProperties: false - type: object properties: field: type: string notIn: minItems: 1 type: array items: type: string required: - field - notIn additionalProperties: false mustEqual: anyOf: - type: string - type: boolean - type: number required: - name - type - required required: - destinationRecipient - fields ValidationErrorDto: type: object properties: type: type: string description: Machine-readable error code example: CUSTOMER_NOT_FOUND title: type: string description: Human-readable error type label example: Customer Not Found status: type: number description: HTTP status code example: 404 detail: type: string description: Human-readable explanation of this occurrence example: Customer with id cus_abc123 not found resolution: type: string description: What the developer should do to resolve this error example: >- Verify the customer ID. Check you are using the correct API key for this organization. docs: type: string description: URL to error documentation example: https://conduit-v2.mintlify.app/errors#customer-not-found instance: type: string description: Request path that produced the error example: /v2/customers/cus_abc123 correlationId: description: Request correlation ID example: req_a1b2c3d4 type: string timestamp: type: string description: ISO 8601 UTC timestamp example: '2026-04-27T20:00:00.000Z' details: description: >- Additional structured data for domain-specific errors (e.g. missing field lists, pair info) errors: type: array items: type: object properties: pointer: type: string description: JSON pointer to the invalid field example: /email detail: type: string description: What is wrong with this field example: Invalid email format allowedValues: description: The values this field accepts, when it is a closed set example: - ach - fedwire - rtp type: array items: type: string category: description: >- Class of blocker (requirements-validator output only). 'field' = form-field gap, 'document' = missing or insufficient document (including per-UBO document slots), 'individual' = required person missing. example: field type: string enum: - field - document - individual required: - pointer - detail required: - type - title - status - detail - resolution - docs - instance - timestamp ProblemDetailDto: type: object properties: type: type: string description: Machine-readable error code example: CUSTOMER_NOT_FOUND title: type: string description: Human-readable error type label example: Customer Not Found status: type: number description: HTTP status code example: 404 detail: type: string description: Human-readable explanation of this occurrence example: Customer with id cus_abc123 not found resolution: type: string description: What the developer should do to resolve this error example: >- Verify the customer ID. Check you are using the correct API key for this organization. docs: type: string description: URL to error documentation example: https://conduit-v2.mintlify.app/errors#customer-not-found instance: type: string description: Request path that produced the error example: /v2/customers/cus_abc123 correlationId: description: Request correlation ID example: req_a1b2c3d4 type: string timestamp: type: string description: ISO 8601 UTC timestamp example: '2026-04-27T20:00:00.000Z' details: description: >- Additional structured data for domain-specific errors (e.g. missing field lists, pair info) required: - type - title - status - detail - resolution - docs - instance - timestamp RateLimitedErrorDto: type: object properties: type: type: string description: Machine-readable error code example: CUSTOMER_NOT_FOUND title: type: string description: Human-readable error type label example: Customer Not Found status: type: number description: HTTP status code example: 404 detail: type: string description: Human-readable explanation of this occurrence example: Customer with id cus_abc123 not found resolution: type: string description: What the developer should do to resolve this error example: >- Verify the customer ID. Check you are using the correct API key for this organization. docs: type: string description: URL to error documentation example: https://conduit-v2.mintlify.app/errors#customer-not-found instance: type: string description: Request path that produced the error example: /v2/customers/cus_abc123 correlationId: description: Request correlation ID example: req_a1b2c3d4 type: string timestamp: type: string description: ISO 8601 UTC timestamp example: '2026-04-27T20:00:00.000Z' details: description: >- Additional structured data for domain-specific errors (e.g. missing field lists, pair info) retryAfterSeconds: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 description: Seconds to wait before retrying example: 3 required: - type - title - status - detail - resolution - docs - instance - timestamp - retryAfterSeconds securitySchemes: api-key: type: apiKey in: header name: x-api-key ````