Recipients
Get recipient requirements
Field schema for creating a recipient.
GET
/
api
/
recipients
/
requirements
Get recipient requirements
curl --request GET \
--url https://api.example.com/api/recipients/requirements \
--header 'Authorization: <authorization>'import requests
url = "https://api.example.com/api/recipients/requirements"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.example.com/api/recipients/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.example.com/api/recipients/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 => [
"Authorization: <authorization>"
],
]);
$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.example.com/api/recipients/requirements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/recipients/requirements")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/recipients/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"required": true,
"fields": [
{ "name": "email", "type": "string", "required": true },
{ "name": "country", "type": "string", "required": true },
{ "name": "transferType", "type": "enum", "required": true, "enum": ["fiat", "stablecoin"] },
{ "name": "accountNumber", "type": "string", "required": true, "visibleWhen": { "transferType": ["fiat"] } },
{ "name": "routingNumber", "type": "string", "required": true, "visibleWhen": { "rail": ["ach", "wire"] } },
{ "name": "iban", "type": "string", "required": true, "visibleWhen": { "rail": ["sepa"] } }
],
"bank": {
"currencies": ["USD", "EUR", "PHP"],
"currencyRailMap": {
"USD": ["ach", "wire"],
"EUR": ["sepa"],
"PHP": ["bank_transfer"]
}
},
"wallet": {
"currencies": ["USDC", "USDCPOLYGON", "USDCARBITRUM"],
"rails": ["arbitrum", "ethereum", "polygon"],
"railLabels": ["Arbitrum", "Ethereum", "Polygon"]
}
}
}
Two sections:
bank for fiat, wallet for stablecoin. Call before POST /recipients.
Scope
recipients:readHeaders
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.
Show data
Show data
boolean
Always
true today.array
Every field that may apply. Rail-specific fields carry
visibleWhen conditions. See Field object.object
Field requirement object
Every entry indata.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"] }).{
"success": true,
"data": {
"required": true,
"fields": [
{ "name": "email", "type": "string", "required": true },
{ "name": "country", "type": "string", "required": true },
{ "name": "transferType", "type": "enum", "required": true, "enum": ["fiat", "stablecoin"] },
{ "name": "accountNumber", "type": "string", "required": true, "visibleWhen": { "transferType": ["fiat"] } },
{ "name": "routingNumber", "type": "string", "required": true, "visibleWhen": { "rail": ["ach", "wire"] } },
{ "name": "iban", "type": "string", "required": true, "visibleWhen": { "rail": ["sepa"] } }
],
"bank": {
"currencies": ["USD", "EUR", "PHP"],
"currencyRailMap": {
"USD": ["ach", "wire"],
"EUR": ["sepa"],
"PHP": ["bank_transfer"]
}
},
"wallet": {
"currencies": ["USDC", "USDCPOLYGON", "USDCARBITRUM"],
"rails": ["arbitrum", "ethereum", "polygon"],
"railLabels": ["Arbitrum", "Ethereum", "Polygon"]
}
}
}
Errors
| Status | Code | Meaning |
|---|---|---|
400 | — | No active routing yet — complete KYB first. |
401 | UNAUTHORIZED | Missing/invalid key. |
403 | FORBIDDEN | Key lacks recipients:read. |
⌘I
Get recipient requirements
curl --request GET \
--url https://api.example.com/api/recipients/requirements \
--header 'Authorization: <authorization>'import requests
url = "https://api.example.com/api/recipients/requirements"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.example.com/api/recipients/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.example.com/api/recipients/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 => [
"Authorization: <authorization>"
],
]);
$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.example.com/api/recipients/requirements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/recipients/requirements")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/recipients/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"required": true,
"fields": [
{ "name": "email", "type": "string", "required": true },
{ "name": "country", "type": "string", "required": true },
{ "name": "transferType", "type": "enum", "required": true, "enum": ["fiat", "stablecoin"] },
{ "name": "accountNumber", "type": "string", "required": true, "visibleWhen": { "transferType": ["fiat"] } },
{ "name": "routingNumber", "type": "string", "required": true, "visibleWhen": { "rail": ["ach", "wire"] } },
{ "name": "iban", "type": "string", "required": true, "visibleWhen": { "rail": ["sepa"] } }
],
"bank": {
"currencies": ["USD", "EUR", "PHP"],
"currencyRailMap": {
"USD": ["ach", "wire"],
"EUR": ["sepa"],
"PHP": ["bank_transfer"]
}
},
"wallet": {
"currencies": ["USDC", "USDCPOLYGON", "USDCARBITRUM"],
"rails": ["arbitrum", "ethereum", "polygon"],
"railLabels": ["Arbitrum", "Ethereum", "Polygon"]
}
}
}