Register a Beneficiary
curl --request POST \
--url https://api.usecleff.com/v1/beneficiaries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "jsmith@example.com",
"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>"
},
"acknowledged": true,
"identity_pending": true
}
'import requests
url = "https://api.usecleff.com/v1/beneficiaries"
payload = {
"email": "jsmith@example.com",
"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>"
},
"acknowledged": True,
"identity_pending": True
}
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({
email: 'jsmith@example.com',
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>'
},
acknowledged: true,
identity_pending: true
})
};
fetch('https://api.usecleff.com/v1/beneficiaries', 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.usecleff.com/v1/beneficiaries",
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([
'email' => 'jsmith@example.com',
'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>'
],
'acknowledged' => true,
'identity_pending' => true
]),
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.usecleff.com/v1/beneficiaries"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\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 \"acknowledged\": true,\n \"identity_pending\": true\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.usecleff.com/v1/beneficiaries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\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 \"acknowledged\": true,\n \"identity_pending\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecleff.com/v1/beneficiaries")
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 \"email\": \"jsmith@example.com\",\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 \"acknowledged\": true,\n \"identity_pending\": true\n}"
response = http.request(request)
puts response.read_body{
"beneficiary": {
"id": "<string>",
"beneficiary_type": "person",
"name": "<string>",
"display_name": "<string>",
"email": "<string>",
"compliance_status": "pending",
"identity_complete": true,
"acknowledged_at": {},
"reacknowledgment_required": true,
"collection_status": "not_invited",
"details_submitted_at": {},
"declared_destination_id": {},
"status": "suspended",
"pending_requests": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "full_onboarding",
"expires_at": "2023-11-07T05:31:56Z"
}
],
"archived_at": {},
"environment": "sandbox",
"created_at": "2023-11-07T05:31:56Z",
"nickname": {},
"phone": {},
"first_name": {},
"last_name": {},
"country_of_residence": {},
"date_of_birth": {},
"business_name": {},
"country_of_incorporation": {},
"registration_number": {},
"tax_id": {},
"postal_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"bank_details": {
"account_holder_name": "<string>",
"country": "<string>",
"currency": "<string>",
"account_number": "<string>",
"routing_code": "<string>",
"iban": "<string>",
"swift_bic": "<string>",
"bank_name": "<string>"
},
"enrollment_status": "pending",
"enrollment_failure_detail": "<string>",
"enrollment_failure_bank_account_id": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "Request validation failed",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_admin",
"environment": "sandbox"
},
"details": [
{
"field": "email",
"code": "invalid_email",
"message": "email must be an email"
}
],
"docs_url": "https://docs.usecleff.com/errors#validation_failed"
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#unauthorized"
}
}{
"error": {
"code": "forbidden",
"message": "Forbidden resource",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_read_only",
"environment": "sandbox"
},
"docs_url": "https://docs.usecleff.com/errors#forbidden"
}
}{
"error": {
"code": "BENEFICIARY_EMAIL_ALREADY_EXISTS",
"message": "A beneficiary with this email already exists",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_admin",
"environment": "sandbox"
},
"docs_url": "https://docs.usecleff.com/errors#beneficiary_email_already_exists"
}
}{
"error": {
"code": "BENEFICIARY_IDENTITY_INVALID",
"message": "Beneficiary of type person requires countryOfResidence",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_admin",
"environment": "sandbox"
},
"docs_url": "https://docs.usecleff.com/errors#beneficiary_identity_invalid"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Slow down and retry after the window.",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#rate_limited"
}
}Beneficiaries
Create a Beneficiary
Creates a Beneficiary scoped to the caller’s Business and environment. Submitting acknowledged=true transitions to compliant immediately.
POST
/
v1
/
beneficiaries
Register a Beneficiary
curl --request POST \
--url https://api.usecleff.com/v1/beneficiaries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "jsmith@example.com",
"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>"
},
"acknowledged": true,
"identity_pending": true
}
'import requests
url = "https://api.usecleff.com/v1/beneficiaries"
payload = {
"email": "jsmith@example.com",
"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>"
},
"acknowledged": True,
"identity_pending": True
}
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({
email: 'jsmith@example.com',
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>'
},
acknowledged: true,
identity_pending: true
})
};
fetch('https://api.usecleff.com/v1/beneficiaries', 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.usecleff.com/v1/beneficiaries",
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([
'email' => 'jsmith@example.com',
'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>'
],
'acknowledged' => true,
'identity_pending' => true
]),
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.usecleff.com/v1/beneficiaries"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\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 \"acknowledged\": true,\n \"identity_pending\": true\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.usecleff.com/v1/beneficiaries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\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 \"acknowledged\": true,\n \"identity_pending\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecleff.com/v1/beneficiaries")
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 \"email\": \"jsmith@example.com\",\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 \"acknowledged\": true,\n \"identity_pending\": true\n}"
response = http.request(request)
puts response.read_body{
"beneficiary": {
"id": "<string>",
"beneficiary_type": "person",
"name": "<string>",
"display_name": "<string>",
"email": "<string>",
"compliance_status": "pending",
"identity_complete": true,
"acknowledged_at": {},
"reacknowledgment_required": true,
"collection_status": "not_invited",
"details_submitted_at": {},
"declared_destination_id": {},
"status": "suspended",
"pending_requests": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "full_onboarding",
"expires_at": "2023-11-07T05:31:56Z"
}
],
"archived_at": {},
"environment": "sandbox",
"created_at": "2023-11-07T05:31:56Z",
"nickname": {},
"phone": {},
"first_name": {},
"last_name": {},
"country_of_residence": {},
"date_of_birth": {},
"business_name": {},
"country_of_incorporation": {},
"registration_number": {},
"tax_id": {},
"postal_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"bank_details": {
"account_holder_name": "<string>",
"country": "<string>",
"currency": "<string>",
"account_number": "<string>",
"routing_code": "<string>",
"iban": "<string>",
"swift_bic": "<string>",
"bank_name": "<string>"
},
"enrollment_status": "pending",
"enrollment_failure_detail": "<string>",
"enrollment_failure_bank_account_id": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "Request validation failed",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_admin",
"environment": "sandbox"
},
"details": [
{
"field": "email",
"code": "invalid_email",
"message": "email must be an email"
}
],
"docs_url": "https://docs.usecleff.com/errors#validation_failed"
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#unauthorized"
}
}{
"error": {
"code": "forbidden",
"message": "Forbidden resource",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_read_only",
"environment": "sandbox"
},
"docs_url": "https://docs.usecleff.com/errors#forbidden"
}
}{
"error": {
"code": "BENEFICIARY_EMAIL_ALREADY_EXISTS",
"message": "A beneficiary with this email already exists",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_admin",
"environment": "sandbox"
},
"docs_url": "https://docs.usecleff.com/errors#beneficiary_email_already_exists"
}
}{
"error": {
"code": "BENEFICIARY_IDENTITY_INVALID",
"message": "Beneficiary of type person requires countryOfResidence",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": {
"user_id": "usr_...",
"membership_id": "mem_...",
"role": "business_admin",
"environment": "sandbox"
},
"docs_url": "https://docs.usecleff.com/errors#beneficiary_identity_invalid"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Slow down and retry after the window.",
"request_id": "req_abc123",
"occurred_at": "2026-07-07T12:00:00.000Z",
"actor": null,
"docs_url": "https://docs.usecleff.com/errors#rate_limited"
}
}Agents: fetch this page as plain markdown at
https://docs.usecleff.com/api-reference/beneficiaries-create.md.Authorizations
Cleff API key, created in the dashboard under Settings → API keys
Body
application/json
Available options:
person, business Optional contact phone. Used for the recipient-enrollment provider KYC step; never an identity field.
Cleff-only display label, preferred over the legal name. Never sent to a provider.
Person: given name
Person: family name
Person: ISO 3166-1 alpha-2 country of residence
Person: date of birth (YYYY-MM-DD)
Business: legal business name
Business: ISO 3166-1 alpha-2 country of incorporation
Business: Cleff-owned KYB record only. Never transmitted to Routefusion.
Tax identifier (Routefusion tax_number)
Optional mailing/legal address
Show child attributes
Show child attributes
Show child attributes
Show child attributes
When true, the Business attests they have verified the beneficiary; transitions to compliant immediately.
When true, create an identity-only stub from legal name + email (awaiting_pii); the per-type detail field is supplied later. acknowledged must not be set.
Response
Show child attributes
Show child attributes