Beneficiaries
Import a Beneficiary base
Creates up to 500 Beneficiaries in one call, each with their bank account and compliance acknowledgment. Rows succeed or fail independently; results carries the outcome of each.
POST
/
v1
/
beneficiaries
/
import
Import verified Beneficiaries with their bank accounts
curl --request POST \
--url https://api.example.com/v1/beneficiaries/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rows": [
{
"email": "jsmith@example.com",
"acknowledged": true,
"bank": {
"account_holder_name": "<string>",
"country": "<string>",
"currency": "<string>",
"account_number": "<string>",
"routing_code": "<string>",
"iban": "<string>",
"swift_bic": "<string>",
"clabe": "<string>",
"pix_key": "<string>",
"bank_name": "<string>"
},
"phone": "<string>",
"nickname": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_of_residence": "<string>",
"date_of_birth": "<string>",
"business_name": "<string>",
"country_of_incorporation": "<string>",
"registration_number": "<string>",
"tax_id": "<string>",
"postal_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
}
]
}
'import requests
url = "https://api.example.com/v1/beneficiaries/import"
payload = { "rows": [
{
"email": "jsmith@example.com",
"acknowledged": True,
"bank": {
"account_holder_name": "<string>",
"country": "<string>",
"currency": "<string>",
"account_number": "<string>",
"routing_code": "<string>",
"iban": "<string>",
"swift_bic": "<string>",
"clabe": "<string>",
"pix_key": "<string>",
"bank_name": "<string>"
},
"phone": "<string>",
"nickname": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_of_residence": "<string>",
"date_of_birth": "<string>",
"business_name": "<string>",
"country_of_incorporation": "<string>",
"registration_number": "<string>",
"tax_id": "<string>",
"postal_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rows: [
{
email: 'jsmith@example.com',
acknowledged: true,
bank: {
account_holder_name: '<string>',
country: '<string>',
currency: '<string>',
account_number: '<string>',
routing_code: '<string>',
iban: '<string>',
swift_bic: '<string>',
clabe: '<string>',
pix_key: '<string>',
bank_name: '<string>'
},
phone: '<string>',
nickname: '<string>',
first_name: '<string>',
last_name: '<string>',
country_of_residence: '<string>',
date_of_birth: '<string>',
business_name: '<string>',
country_of_incorporation: '<string>',
registration_number: '<string>',
tax_id: '<string>',
postal_address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>'
}
}
]
})
};
fetch('https://api.example.com/v1/beneficiaries/import', 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/v1/beneficiaries/import",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rows' => [
[
'email' => 'jsmith@example.com',
'acknowledged' => true,
'bank' => [
'account_holder_name' => '<string>',
'country' => '<string>',
'currency' => '<string>',
'account_number' => '<string>',
'routing_code' => '<string>',
'iban' => '<string>',
'swift_bic' => '<string>',
'clabe' => '<string>',
'pix_key' => '<string>',
'bank_name' => '<string>'
],
'phone' => '<string>',
'nickname' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'country_of_residence' => '<string>',
'date_of_birth' => '<string>',
'business_name' => '<string>',
'country_of_incorporation' => '<string>',
'registration_number' => '<string>',
'tax_id' => '<string>',
'postal_address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/beneficiaries/import"
payload := strings.NewReader("{\n \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"acknowledged\": true,\n \"bank\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n },\n \"phone\": \"<string>\",\n \"nickname\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country_of_residence\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"business_name\": \"<string>\",\n \"country_of_incorporation\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"postal_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/beneficiaries/import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"acknowledged\": true,\n \"bank\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n },\n \"phone\": \"<string>\",\n \"nickname\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country_of_residence\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"business_name\": \"<string>\",\n \"country_of_incorporation\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"postal_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/beneficiaries/import")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"acknowledged\": true,\n \"bank\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n },\n \"phone\": \"<string>\",\n \"nickname\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country_of_residence\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"business_name\": \"<string>\",\n \"country_of_incorporation\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"postal_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"index": 123,
"status": "created",
"beneficiary_id": "<string>",
"bank_account_id": "<string>",
"payout_usable": true,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
}
],
"created_count": 123,
"failed_count": 123
}Authorizations
Cleff API key issued to a Business that self-registers via POST /v1/registration
Body
application/json
Rows to import (1..500). Each row is validated on its own.
Show child attributes
Show child attributes
⌘I
Import verified Beneficiaries with their bank accounts
curl --request POST \
--url https://api.example.com/v1/beneficiaries/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rows": [
{
"email": "jsmith@example.com",
"acknowledged": true,
"bank": {
"account_holder_name": "<string>",
"country": "<string>",
"currency": "<string>",
"account_number": "<string>",
"routing_code": "<string>",
"iban": "<string>",
"swift_bic": "<string>",
"clabe": "<string>",
"pix_key": "<string>",
"bank_name": "<string>"
},
"phone": "<string>",
"nickname": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_of_residence": "<string>",
"date_of_birth": "<string>",
"business_name": "<string>",
"country_of_incorporation": "<string>",
"registration_number": "<string>",
"tax_id": "<string>",
"postal_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
}
]
}
'import requests
url = "https://api.example.com/v1/beneficiaries/import"
payload = { "rows": [
{
"email": "jsmith@example.com",
"acknowledged": True,
"bank": {
"account_holder_name": "<string>",
"country": "<string>",
"currency": "<string>",
"account_number": "<string>",
"routing_code": "<string>",
"iban": "<string>",
"swift_bic": "<string>",
"clabe": "<string>",
"pix_key": "<string>",
"bank_name": "<string>"
},
"phone": "<string>",
"nickname": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_of_residence": "<string>",
"date_of_birth": "<string>",
"business_name": "<string>",
"country_of_incorporation": "<string>",
"registration_number": "<string>",
"tax_id": "<string>",
"postal_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rows: [
{
email: 'jsmith@example.com',
acknowledged: true,
bank: {
account_holder_name: '<string>',
country: '<string>',
currency: '<string>',
account_number: '<string>',
routing_code: '<string>',
iban: '<string>',
swift_bic: '<string>',
clabe: '<string>',
pix_key: '<string>',
bank_name: '<string>'
},
phone: '<string>',
nickname: '<string>',
first_name: '<string>',
last_name: '<string>',
country_of_residence: '<string>',
date_of_birth: '<string>',
business_name: '<string>',
country_of_incorporation: '<string>',
registration_number: '<string>',
tax_id: '<string>',
postal_address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>'
}
}
]
})
};
fetch('https://api.example.com/v1/beneficiaries/import', 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/v1/beneficiaries/import",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rows' => [
[
'email' => 'jsmith@example.com',
'acknowledged' => true,
'bank' => [
'account_holder_name' => '<string>',
'country' => '<string>',
'currency' => '<string>',
'account_number' => '<string>',
'routing_code' => '<string>',
'iban' => '<string>',
'swift_bic' => '<string>',
'clabe' => '<string>',
'pix_key' => '<string>',
'bank_name' => '<string>'
],
'phone' => '<string>',
'nickname' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'country_of_residence' => '<string>',
'date_of_birth' => '<string>',
'business_name' => '<string>',
'country_of_incorporation' => '<string>',
'registration_number' => '<string>',
'tax_id' => '<string>',
'postal_address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/beneficiaries/import"
payload := strings.NewReader("{\n \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"acknowledged\": true,\n \"bank\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n },\n \"phone\": \"<string>\",\n \"nickname\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country_of_residence\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"business_name\": \"<string>\",\n \"country_of_incorporation\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"postal_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/beneficiaries/import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"acknowledged\": true,\n \"bank\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n },\n \"phone\": \"<string>\",\n \"nickname\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country_of_residence\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"business_name\": \"<string>\",\n \"country_of_incorporation\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"postal_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/beneficiaries/import")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"acknowledged\": true,\n \"bank\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n },\n \"phone\": \"<string>\",\n \"nickname\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country_of_residence\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"business_name\": \"<string>\",\n \"country_of_incorporation\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"postal_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"index": 123,
"status": "created",
"beneficiary_id": "<string>",
"bank_account_id": "<string>",
"payout_usable": true,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
}
],
"created_count": 123,
"failed_count": 123
}