List required recipient fields

GET

orders

requirements

curl --request GET \
  --url https://api.sandbox.conduit.financial/v2/orders/requirements \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.conduit.financial/v2/orders/requirements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.conduit.financial/v2/orders/requirements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.conduit.financial/v2/orders/requirements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.conduit.financial/v2/orders/requirements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "destinationRecipient": "required",
  "fields": [
    {
      "name": "destination.recipient.accountNumber",
      "type": "string",
      "required": true,
      "minLength": 123,
      "maxLength": 123,
      "pattern": "<string>",
      "enum": [
        "<string>"
      ],
      "validator": "aba",
      "requiredWhen": {
        "field": "<string>",
        "equals": "<string>"
      },
      "mustEqual": "<string>",
      "requiredOneOf": "accountIdentifier"
    }
  ],
  "fieldDescriptors": [
    {
      "pointer": "/businessInfo/taxId",
      "label": "Tax Identification Number",
      "type": "string",
      "required": true,
      "helpText": "Issued by HMRC. 10-digit number; auto-assigned on CT registration; appears on HMRC correspondence. VAT Registration Number (GB + 9 digits; XI prefix for NI–EU trade) is supplementary — collect separately if VAT-registered.",
      "group": "<string>",
      "mustEqual": true,
      "constraints": {
        "pattern": "^\\d{2}\\.\\d{3}\\.\\d{3}/\\d{4}-\\d{2}$",
        "example": "12.345.678/0001-95",
        "format": "safeString",
        "minLength": 0,
        "maxLength": 0,
        "min": 123,
        "max": 123,
        "minDate": "1800-01-01",
        "maxDate": "today",
        "maxDateTime": "now",
        "minAgeYears": 0,
        "maxAgeYears": 0,
        "checksum": "aba"
      },
      "requiredOneOf": "accountIdentifier",
      "conditions": [
        {
          "pointer": "/companyClassification/legalStructure",
          "operator": "eq",
          "value": "<string>",
          "values": [
            "<string>"
          ],
          "scope": "root"
        }
      ],
      "allowedValues": [
        "LLC",
        "CORPORATION",
        "PARTNERSHIP"
      ],
      "options": [
        {
          "value": "Sociedad Anónima",
          "label": "Sociedad Anónima",
          "abbr": "S.A.",
          "description": "<string>",
          "category": "Corp"
        }
      ],
      "conditionalOverrides": [
        {
          "conditions": [
            {
              "pointer": "/companyClassification/legalStructure",
              "operator": "eq",
              "value": "<string>",
              "values": [
                "<string>"
              ],
              "scope": "root"
            }
          ],
          "constraints": {
            "pattern": "^\\d{2}\\.\\d{3}\\.\\d{3}/\\d{4}-\\d{2}$",
            "example": "12.345.678/0001-95",
            "format": "safeString",
            "minLength": 0,
            "maxLength": 0,
            "min": 123,
            "max": 123,
            "minDate": "1800-01-01",
            "maxDate": "today",
            "maxDateTime": "now",
            "minAgeYears": 0,
            "maxAgeYears": 0,
            "checksum": "aba"
          },
          "allowedValues": [
            "SSN"
          ]
        }
      ]
    }
  ],
  "reason": "<string>"
}

{
  "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://v2.docs.conduit.financial/errors#invalid-oid-format",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "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://v2.docs.conduit.financial/errors#api-key-missing",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "ORGANIZATION_ACCESS_SUSPENDED",
  "title": "Organization Access Suspended",
  "status": 403,
  "detail": "Conduit has suspended this organization's access. Requests with the organization's API keys and from its users are refused until Conduit restores access.",
  "resolution": "Contact Conduit support.",
  "docs": "https://v2.docs.conduit.financial/errors#organization-access-suspended",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "UNSUPPORTED_PAIR",
  "title": "Unsupported Pair",
  "status": 422,
  "detail": "The requested source and destination asset pair is not supported. `details` carries `sourceChain` and `destinationChain` alongside `sourceAsset` and `destinationAsset` — `null` for a fiat asset, which carries no chain — so you can tell a chain-specific refusal from an asset-wide one. A conversion to or from OUSD also returns this code, with `details.reason` set to `ousd_conversion_not_enabled`: you can receive, hold, send and bridge OUSD, but not convert it.",
  "resolution": "Submit a supported source/destination asset combination and chain, or contact Conduit if this pair should be available.",
  "docs": "https://v2.docs.conduit.financial/errors#unsupported-pair",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "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 (the bucket size), X-RateLimit-Remaining, and X-RateLimit-Reset (seconds until the bucket refills) on every response once your API key is accepted.",
  "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://v2.docs.conduit.financial/errors#rate-limited",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z",
  "retryAfterSeconds": 3
}

{
  "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://v2.docs.conduit.financial/errors#internal-error",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

Authorizations

x-api-key

string

header

required

Query Parameters

sourceCode

enum<string>

required

Source asset code (e.g. USDC, USD).

Available options:

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,

OUSD,

BTC,

ETH,

SOL,

TRX,

XLM,

POL

sourceChain

enum<string>

Source chain when the source asset is a crypto token (e.g. ethereum). Omitted for fiat sources.

Available options:

ethereum,

base,

solana,

polygon,

tron,

stellar,

tempo,

arbitrum,

optimism,

arc

destinationCode

enum<string>

required

Destination asset code (e.g. USD, USDC).

Available options:

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,

OUSD,

BTC,

ETH,

SOL,

TRX,

XLM,

POL

destinationChain

enum<string>

Destination chain when the destination asset is a crypto token. Omitted for fiat destinations.

Available options:

ethereum,

base,

solana,

polygon,

tron,

stellar,

tempo,

arbitrum,

optimism,

arc

destinationCountry

string

Beneficiary country ISO 3166-1 alpha-2 or alpha-3 code. Required when the destination is a fiat bank rail. The rail selects the fields. The country decides whether postalAddress.postalCode is required: a country that uses postal codes gets required: true, and any other country keeps requiredWhen on postalAddress.country. chaps requires it for every country.

paymentRail

enum<string>

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

Available options:

rtp,

fedwire,

ach,

ach_same_day,

swift,

fednow,

sepa,

faster_payments,

chaps,

pix,

ted,

nibss,

spei

recipientType

enum<string>

Whether the recipient is an individual or a business.

Available options:

individual,

business

recipientRail

enum<string>

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

Available options:

crypto

Response

destinationRecipient

enum<string>

required

Available options:

required,

none

fields

object[]

required

Show child attributes

fieldDescriptors

object[]

required

The fields to send, in the same shape that fields has on the onboarding and feature requirements endpoints. pointer is an RFC 6901 JSON Pointer to the place of the value in the create request body. A field that has conditions is required only while every condition holds. fields gives the same fields in its earlier shape.

Show child attributes

reason

string

⌘I

List required recipient fields

curl --request GET \
  --url https://api.sandbox.conduit.financial/v2/orders/requirements \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.conduit.financial/v2/orders/requirements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.conduit.financial/v2/orders/requirements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.conduit.financial/v2/orders/requirements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.conduit.financial/v2/orders/requirements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "destinationRecipient": "required",
  "fields": [
    {
      "name": "destination.recipient.accountNumber",
      "type": "string",
      "required": true,
      "minLength": 123,
      "maxLength": 123,
      "pattern": "<string>",
      "enum": [
        "<string>"
      ],
      "validator": "aba",
      "requiredWhen": {
        "field": "<string>",
        "equals": "<string>"
      },
      "mustEqual": "<string>",
      "requiredOneOf": "accountIdentifier"
    }
  ],
  "fieldDescriptors": [
    {
      "pointer": "/businessInfo/taxId",
      "label": "Tax Identification Number",
      "type": "string",
      "required": true,
      "helpText": "Issued by HMRC. 10-digit number; auto-assigned on CT registration; appears on HMRC correspondence. VAT Registration Number (GB + 9 digits; XI prefix for NI–EU trade) is supplementary — collect separately if VAT-registered.",
      "group": "<string>",
      "mustEqual": true,
      "constraints": {
        "pattern": "^\\d{2}\\.\\d{3}\\.\\d{3}/\\d{4}-\\d{2}$",
        "example": "12.345.678/0001-95",
        "format": "safeString",
        "minLength": 0,
        "maxLength": 0,
        "min": 123,
        "max": 123,
        "minDate": "1800-01-01",
        "maxDate": "today",
        "maxDateTime": "now",
        "minAgeYears": 0,
        "maxAgeYears": 0,
        "checksum": "aba"
      },
      "requiredOneOf": "accountIdentifier",
      "conditions": [
        {
          "pointer": "/companyClassification/legalStructure",
          "operator": "eq",
          "value": "<string>",
          "values": [
            "<string>"
          ],
          "scope": "root"
        }
      ],
      "allowedValues": [
        "LLC",
        "CORPORATION",
        "PARTNERSHIP"
      ],
      "options": [
        {
          "value": "Sociedad Anónima",
          "label": "Sociedad Anónima",
          "abbr": "S.A.",
          "description": "<string>",
          "category": "Corp"
        }
      ],
      "conditionalOverrides": [
        {
          "conditions": [
            {
              "pointer": "/companyClassification/legalStructure",
              "operator": "eq",
              "value": "<string>",
              "values": [
                "<string>"
              ],
              "scope": "root"
            }
          ],
          "constraints": {
            "pattern": "^\\d{2}\\.\\d{3}\\.\\d{3}/\\d{4}-\\d{2}$",
            "example": "12.345.678/0001-95",
            "format": "safeString",
            "minLength": 0,
            "maxLength": 0,
            "min": 123,
            "max": 123,
            "minDate": "1800-01-01",
            "maxDate": "today",
            "maxDateTime": "now",
            "minAgeYears": 0,
            "maxAgeYears": 0,
            "checksum": "aba"
          },
          "allowedValues": [
            "SSN"
          ]
        }
      ]
    }
  ],
  "reason": "<string>"
}

{
  "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://v2.docs.conduit.financial/errors#invalid-oid-format",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "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://v2.docs.conduit.financial/errors#api-key-missing",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "ORGANIZATION_ACCESS_SUSPENDED",
  "title": "Organization Access Suspended",
  "status": 403,
  "detail": "Conduit has suspended this organization's access. Requests with the organization's API keys and from its users are refused until Conduit restores access.",
  "resolution": "Contact Conduit support.",
  "docs": "https://v2.docs.conduit.financial/errors#organization-access-suspended",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "UNSUPPORTED_PAIR",
  "title": "Unsupported Pair",
  "status": 422,
  "detail": "The requested source and destination asset pair is not supported. `details` carries `sourceChain` and `destinationChain` alongside `sourceAsset` and `destinationAsset` — `null` for a fiat asset, which carries no chain — so you can tell a chain-specific refusal from an asset-wide one. A conversion to or from OUSD also returns this code, with `details.reason` set to `ousd_conversion_not_enabled`: you can receive, hold, send and bridge OUSD, but not convert it.",
  "resolution": "Submit a supported source/destination asset combination and chain, or contact Conduit if this pair should be available.",
  "docs": "https://v2.docs.conduit.financial/errors#unsupported-pair",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "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 (the bucket size), X-RateLimit-Remaining, and X-RateLimit-Reset (seconds until the bucket refills) on every response once your API key is accepted.",
  "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://v2.docs.conduit.financial/errors#rate-limited",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z",
  "retryAfterSeconds": 3
}

{
  "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://v2.docs.conduit.financial/errors#internal-error",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

Overview

Errors

Customers

Registered Addresses

Wallets

Wallet Signers

Signing Quorum

Virtual Accounts

Applications

Verifications

Signing Requests

Transactions

Payouts

RFIs

Documents

Payee checks

Whitelist Recipients

Orders

Asset Chain Pairs

Quotes

Webhook Endpoints

Webhook Deliveries

Webhook Event Types

Events

Features

Customer Onboarding

Markup

Sandbox

List required recipient fields

Authorizations

Query Parameters

Response