Skip to main content
Create a beneficiary record to store recipient information for future payouts. After creating a beneficiary, add their payment method details using the payment methods endpoint. 
POST /v1/beneficiaries
Requires an Idempotency-Key header.

​
Request body

​
recipient_type
string
required
Beneficiary type: "individual" or "business".
​
customer_name
string
required
Full name of the beneficiary (individual) or legal business name.
​
customer_email
string
required
Beneficiary’s email address.
​
customer_address
string
required
Beneficiary’s physical address.
​
country
string
required
Beneficiary’s country code (e.g. CHL, MEX, BRA).
​
customer_nickname
string
A short label for this beneficiary. Defaults to customer_name if omitted.
curl -X POST 'https://api.yativo.com/api/v1/beneficiaries' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "recipient_type": "individual",
    "customer_name": "Maria Gonzalez",
    "customer_email": "maria.gonzalez@example.com",
    "customer_address": "123 Main Street, Santiago",
    "country": "CHL",
    "customer_nickname": "Maria"
  }'

{
  "status": "success",
  "data": {
    "id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
    "user_id": "usr-001",
    "recipient_type": "individual",
    "customer_name": "Maria Gonzalez",
    "customer_email": "maria.gonzalez@example.com",
    "customer_nickname": "Maria",
    "country": "CHL",
    "customer_address": "123 Main Street, Santiago",
    "is_archived": false,
    "created_at": "2026-04-02T10:00:00.000000Z",
    "updated_at": "2026-04-02T10:00:00.000000Z"
  }
}