Skip to main content
GET
Get recipient requirements
Two sections: bank for fiat, wallet for stablecoin. Call before POST /recipients.
Scope recipients:read

Headers

string
required
API key.

Query parameters

string
Optional. self or third_party.
string
Optional ISO 3166-1 alpha-2. Filters out rails not valid for the country.

Response

boolean
true on success.
object
The merged schema.

Field requirement object

Every entry in data.fields has this shape:
string
JSON key on the create-recipient body.
string
string · number · enum · object · array.
boolean
Required on submit.
string
Form label / hint.
string[]
Allowed values (enum).
object
Show only when sibling fields match (e.g. { rail: ["ach", "wire"] }).

Errors