Update beneficiary

PUT

beneficiaries

{id}

Update beneficiary

curl --request PUT \
  --url https://api.example.com/v1/beneficiaries/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "Hauptstraße 123",
  "addressLine2": "Apt 4B, 3rd Floor",
  "city": "Berlin",
  "countrySubdivision": "NY",
  "dateOfBirth": "1985-05-20",
  "email": "john.doe@example.com",
  "middleName": "James",
  "name": "John Doe",
  "notes": "Regular client, prefers SEPA Instant",
  "postcode": "10115",
  "registrationNumber": "2019/123456/07",
  "status": "active",
  "type": "individual"
}
'

import requests

url = "https://api.example.com/v1/beneficiaries/{id}"

payload = {
    "address": "Hauptstraße 123",
    "addressLine2": "Apt 4B, 3rd Floor",
    "city": "Berlin",
    "countrySubdivision": "NY",
    "dateOfBirth": "1985-05-20",
    "email": "john.doe@example.com",
    "middleName": "James",
    "name": "John Doe",
    "notes": "Regular client, prefers SEPA Instant",
    "postcode": "10115",
    "registrationNumber": "2019/123456/07",
    "status": "active",
    "type": "individual"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address: 'Hauptstraße 123',
    addressLine2: 'Apt 4B, 3rd Floor',
    city: 'Berlin',
    countrySubdivision: 'NY',
    dateOfBirth: '1985-05-20',
    email: 'john.doe@example.com',
    middleName: 'James',
    name: 'John Doe',
    notes: 'Regular client, prefers SEPA Instant',
    postcode: '10115',
    registrationNumber: '2019/123456/07',
    status: 'active',
    type: 'individual'
  })
};

fetch('https://api.example.com/v1/beneficiaries/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'address' => 'Hauptstraße 123',
    'addressLine2' => 'Apt 4B, 3rd Floor',
    'city' => 'Berlin',
    'countrySubdivision' => 'NY',
    'dateOfBirth' => '1985-05-20',
    'email' => 'john.doe@example.com',
    'middleName' => 'James',
    'name' => 'John Doe',
    'notes' => 'Regular client, prefers SEPA Instant',
    'postcode' => '10115',
    'registrationNumber' => '2019/123456/07',
    'status' => 'active',
    'type' => 'individual'
  ]),
  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/{id}"

	payload := strings.NewReader("{\n  \"address\": \"Hauptstraße 123\",\n  \"addressLine2\": \"Apt 4B, 3rd Floor\",\n  \"city\": \"Berlin\",\n  \"countrySubdivision\": \"NY\",\n  \"dateOfBirth\": \"1985-05-20\",\n  \"email\": \"john.doe@example.com\",\n  \"middleName\": \"James\",\n  \"name\": \"John Doe\",\n  \"notes\": \"Regular client, prefers SEPA Instant\",\n  \"postcode\": \"10115\",\n  \"registrationNumber\": \"2019/123456/07\",\n  \"status\": \"active\",\n  \"type\": \"individual\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/v1/beneficiaries/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"Hauptstraße 123\",\n  \"addressLine2\": \"Apt 4B, 3rd Floor\",\n  \"city\": \"Berlin\",\n  \"countrySubdivision\": \"NY\",\n  \"dateOfBirth\": \"1985-05-20\",\n  \"email\": \"john.doe@example.com\",\n  \"middleName\": \"James\",\n  \"name\": \"John Doe\",\n  \"notes\": \"Regular client, prefers SEPA Instant\",\n  \"postcode\": \"10115\",\n  \"registrationNumber\": \"2019/123456/07\",\n  \"status\": \"active\",\n  \"type\": \"individual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/beneficiaries/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"Hauptstraße 123\",\n  \"addressLine2\": \"Apt 4B, 3rd Floor\",\n  \"city\": \"Berlin\",\n  \"countrySubdivision\": \"NY\",\n  \"dateOfBirth\": \"1985-05-20\",\n  \"email\": \"john.doe@example.com\",\n  \"middleName\": \"James\",\n  \"name\": \"John Doe\",\n  \"notes\": \"Regular client, prefers SEPA Instant\",\n  \"postcode\": \"10115\",\n  \"registrationNumber\": \"2019/123456/07\",\n  \"status\": \"active\",\n  \"type\": \"individual\"\n}"

response = http.request(request)
puts response.read_body

{
  "accounts": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "currency": "EUR",
      "data": {
        "bic": "DEUTDEFF",
        "iban": "DE89370400440532013000"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "active",
      "type": "iban",
      "updatedAt": "2024-01-15T10:35:00Z",
      "resolutionStatus": "resolved",
      "resolvedAccountName": "JANE DOE"
    }
  ],
  "country": "DE",
  "createdAt": "2024-01-15T10:30:00Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "John Doe",
  "status": "active",
  "type": "individual",
  "updatedAt": "2024-01-15T10:30:00Z",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "address": "Hauptstraße 123",
  "addressLine2": "Apt 4B, 3rd Floor",
  "city": "Berlin",
  "countrySubdivision": "NY",
  "dateOfBirth": "1985-05-20",
  "email": "john.doe@example.com",
  "middleName": "James",
  "notes": "Regular client, prefers SEPA Instant",
  "postcode": "10115",
  "registrationNumber": "2019/123456/07"
}

{
  "details": [
    {
      "field": "accounts.0.data",
      "message": "crAccount must be exactly 10 digits for Nigerian accounts"
    }
  ],
  "error": "BAD_REQUEST",
  "message": "crAccount must be exactly 10 digits for Nigerian accounts",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Authorizations

Authorization

string

header

required

Enter Auth0 JWT token

Headers

Zuba-Account-Id

string<uuid>

Optional. Names an owned sub-account (UUID) to act on. Omit to act at the master (tenant) level. Naming an account this key does not own returns 403 not_account_owner.

Path Parameters

string<uuid>

required

Unique identifier for the beneficiary

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

address

string

Address line 1 of the beneficiary (max 200 characters)

Maximum string length: 200

Example:

"Hauptstraße 123"

addressLine2

string

Address line 2 of the beneficiary (max 200 characters)

Maximum string length: 200

Example:

"Apt 4B, 3rd Floor"

city

string

City of the beneficiary

Maximum string length: 100

Example:

"Berlin"

countrySubdivision

string

Country subdivision code (e.g., US state code "NY", "CA")

Maximum string length: 50

Example:

"NY"

dateOfBirth

string

Date of birth in YYYY-MM-DD format (individual beneficiaries only). Use this to add one to a saved individual beneficiary before sending a crypto payout while Travel Rule screening is enabled.

Example:

"1985-05-20"

string<email>

Email address of the beneficiary

Example:

"john.doe@example.com"

middleName

string

Middle name of the beneficiary (max 100 characters)

Maximum string length: 100

Example:

"James"

name

string

Full name of the beneficiary (2-100 characters)

Required string length: 2 - 100

Example:

"John Doe"

notes

string

Notes about the beneficiary (max 500 characters)

Maximum string length: 500

Example:

"Regular client, prefers SEPA Instant"

postcode

string

Postal code of the beneficiary

Maximum string length: 20

Example:

"10115"

registrationNumber

string

Company registration number (business beneficiaries only, max 100 characters). Required for a business beneficiary on some corridors; use GET /v1/payouts/requirements to check.

Maximum string length: 100

Example:

"2019/123456/07"

status

enum<string>

Beneficiary status. inactive is not settable here — deleting a beneficiary goes through DELETE /v1/beneficiaries/{id}, which refuses while a payout or order against it is still live.

Available options:

active,

suspended

Example:

"active"

type

enum<string>

Beneficiary type

Available options:

individual,

business

Example:

"individual"

Response

Beneficiary updated successfully

accounts

object[]

required

Array of associated payment accounts

Show child attributes

country

string

required

Country code (ISO 3166-1 alpha-2)

Example:

"DE"

createdAt

string<date-time>

required

ISO timestamp when the beneficiary was created

Example:

"2024-01-15T10:30:00Z"

string<uuid>

required

Unique identifier for the beneficiary

Example:

"123e4567-e89b-12d3-a456-426614174000"

name

string

required

Full name of the beneficiary

Example:

"John Doe"

status

enum<string>

required

Beneficiary status

Available options:

active,

inactive,

suspended

Example:

"active"

type

enum<string>

required

Beneficiary type

Available options:

individual,

business

Example:

"individual"

updatedAt

string<date-time>

required

ISO timestamp when the beneficiary was last updated

Example:

"2024-01-15T10:30:00Z"

accountId

string<uuid>

The sub-account this beneficiary belongs to. Absent on the workspace’s own. A headerless list is a rollup over both, so this is what tells them apart.

address

string

Address line 1 of the beneficiary

Example:

"Hauptstraße 123"

addressLine2

string

Address line 2 of the beneficiary

Example:

"Apt 4B, 3rd Floor"

city

string

City of the beneficiary

Example:

"Berlin"

countrySubdivision

string

Country subdivision code (e.g., US state code "NY", "CA")

Example:

"NY"

dateOfBirth

string

Date of birth in YYYY-MM-DD format (individual beneficiaries only).

Example:

"1985-05-20"

string

Email address of the beneficiary

Example:

"john.doe@example.com"

middleName

string

Middle name of the beneficiary

Example:

"James"

notes

string

Notes about the beneficiary

Example:

"Regular client, prefers SEPA Instant"

postcode

string

Postal code of the beneficiary

Example:

"10115"

registrationNumber

string

Company registration number (business beneficiaries only).

Example:

"2019/123456/07"

Update beneficiary

curl --request PUT \
  --url https://api.example.com/v1/beneficiaries/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "Hauptstraße 123",
  "addressLine2": "Apt 4B, 3rd Floor",
  "city": "Berlin",
  "countrySubdivision": "NY",
  "dateOfBirth": "1985-05-20",
  "email": "john.doe@example.com",
  "middleName": "James",
  "name": "John Doe",
  "notes": "Regular client, prefers SEPA Instant",
  "postcode": "10115",
  "registrationNumber": "2019/123456/07",
  "status": "active",
  "type": "individual"
}
'

import requests

url = "https://api.example.com/v1/beneficiaries/{id}"

payload = {
    "address": "Hauptstraße 123",
    "addressLine2": "Apt 4B, 3rd Floor",
    "city": "Berlin",
    "countrySubdivision": "NY",
    "dateOfBirth": "1985-05-20",
    "email": "john.doe@example.com",
    "middleName": "James",
    "name": "John Doe",
    "notes": "Regular client, prefers SEPA Instant",
    "postcode": "10115",
    "registrationNumber": "2019/123456/07",
    "status": "active",
    "type": "individual"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address: 'Hauptstraße 123',
    addressLine2: 'Apt 4B, 3rd Floor',
    city: 'Berlin',
    countrySubdivision: 'NY',
    dateOfBirth: '1985-05-20',
    email: 'john.doe@example.com',
    middleName: 'James',
    name: 'John Doe',
    notes: 'Regular client, prefers SEPA Instant',
    postcode: '10115',
    registrationNumber: '2019/123456/07',
    status: 'active',
    type: 'individual'
  })
};

fetch('https://api.example.com/v1/beneficiaries/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'address' => 'Hauptstraße 123',
    'addressLine2' => 'Apt 4B, 3rd Floor',
    'city' => 'Berlin',
    'countrySubdivision' => 'NY',
    'dateOfBirth' => '1985-05-20',
    'email' => 'john.doe@example.com',
    'middleName' => 'James',
    'name' => 'John Doe',
    'notes' => 'Regular client, prefers SEPA Instant',
    'postcode' => '10115',
    'registrationNumber' => '2019/123456/07',
    'status' => 'active',
    'type' => 'individual'
  ]),
  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/{id}"

	payload := strings.NewReader("{\n  \"address\": \"Hauptstraße 123\",\n  \"addressLine2\": \"Apt 4B, 3rd Floor\",\n  \"city\": \"Berlin\",\n  \"countrySubdivision\": \"NY\",\n  \"dateOfBirth\": \"1985-05-20\",\n  \"email\": \"john.doe@example.com\",\n  \"middleName\": \"James\",\n  \"name\": \"John Doe\",\n  \"notes\": \"Regular client, prefers SEPA Instant\",\n  \"postcode\": \"10115\",\n  \"registrationNumber\": \"2019/123456/07\",\n  \"status\": \"active\",\n  \"type\": \"individual\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/v1/beneficiaries/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"Hauptstraße 123\",\n  \"addressLine2\": \"Apt 4B, 3rd Floor\",\n  \"city\": \"Berlin\",\n  \"countrySubdivision\": \"NY\",\n  \"dateOfBirth\": \"1985-05-20\",\n  \"email\": \"john.doe@example.com\",\n  \"middleName\": \"James\",\n  \"name\": \"John Doe\",\n  \"notes\": \"Regular client, prefers SEPA Instant\",\n  \"postcode\": \"10115\",\n  \"registrationNumber\": \"2019/123456/07\",\n  \"status\": \"active\",\n  \"type\": \"individual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/beneficiaries/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"Hauptstraße 123\",\n  \"addressLine2\": \"Apt 4B, 3rd Floor\",\n  \"city\": \"Berlin\",\n  \"countrySubdivision\": \"NY\",\n  \"dateOfBirth\": \"1985-05-20\",\n  \"email\": \"john.doe@example.com\",\n  \"middleName\": \"James\",\n  \"name\": \"John Doe\",\n  \"notes\": \"Regular client, prefers SEPA Instant\",\n  \"postcode\": \"10115\",\n  \"registrationNumber\": \"2019/123456/07\",\n  \"status\": \"active\",\n  \"type\": \"individual\"\n}"

response = http.request(request)
puts response.read_body

{
  "accounts": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "currency": "EUR",
      "data": {
        "bic": "DEUTDEFF",
        "iban": "DE89370400440532013000"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "active",
      "type": "iban",
      "updatedAt": "2024-01-15T10:35:00Z",
      "resolutionStatus": "resolved",
      "resolvedAccountName": "JANE DOE"
    }
  ],
  "country": "DE",
  "createdAt": "2024-01-15T10:30:00Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "John Doe",
  "status": "active",
  "type": "individual",
  "updatedAt": "2024-01-15T10:30:00Z",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "address": "Hauptstraße 123",
  "addressLine2": "Apt 4B, 3rd Floor",
  "city": "Berlin",
  "countrySubdivision": "NY",
  "dateOfBirth": "1985-05-20",
  "email": "john.doe@example.com",
  "middleName": "James",
  "notes": "Regular client, prefers SEPA Instant",
  "postcode": "10115",
  "registrationNumber": "2019/123456/07"
}

{
  "details": [
    {
      "field": "accounts.0.data",
      "message": "crAccount must be exactly 10 digits for Nigerian accounts"
    }
  ],
  "error": "BAD_REQUEST",
  "message": "crAccount must be exactly 10 digits for Nigerian accounts",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}