Skip to main content
PUT
Fully replace a beneficiary’s profile information. This is a full replacement — all required fields must be included in every request. Omitting a required field will overwrite it with an empty or default value.
Requires an Idempotency-Key header.

Request body

This endpoint performs a full replacement. You must send all required fields on every call, not just the fields you want to change.

Authorizations

X-Api-Key
string
header
required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret
string
header
required

Your API secret (yativo_sk_...), shown once when the key is created.

Headers

Idempotency-Key
string
required

A unique string per request to ensure idempotent processing.

Path Parameters

id
string
required

The ID of the beneficiary to update.

Body

application/json
recipient_type
enum<string>
required

Beneficiary type: "individual" or "business".

Available options:
individual,
business
customer_name
string
required

Full name of the beneficiary (individual) or legal business name.

customer_email
string<email>
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.

Response

200 - application/json

Beneficiary updated

message
string