Update a Beneficiary

Update a Beneficiary for a Customer Account. Beneficiaries can only belong to a Business Customer (not an Individual Customer).

Endpoint

PUT /v1/customers/{customerId}/beneficiaries/{beneficiaryId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

customerId REQUIRED

string (UUID)

ID of the Customer Account to which the Beneficiary belongs.

beneficiaryId REQUIRED

string (UUID)

ID of the Beneficiary.

Request Body

firstName

string, min length: 1, max length: 40

Beneficiary’s first name.

middleName

string, min length: 1, max length: 40

Beneficiary’s middle name.

lastName

string, min length: 1, max length: 40

Beneficiary’s last name.

sex

string enum, values: MALE, FEMALE, NONBINARY

Beneficiary’s sex.

primaryPhoneNumber

object

Beneficiary’s primary phone number.

number REQUIRED

string

Phone number. Can be entered in any of the following formats:

[+][country code][phone number including area code] (example: +14151234)
[country code][phone number including area code] (example: 14151234)
[phone number including area code] (example: 4151234)

RocketKOR will convert the phone number to E.164 format (example: +14151234).

type REQUIRED

string enum, values: WORK, HOME, MOBILE

Type of phone number.

provider

string, min length: 1, max length: 40

Phone provider.

extension

string, min length: 1, max length: 10

Phone extension.

verified

boolean

Whether the phone number has been verified.

primaryEmail

object

Beneficiary’s primary email address.

value REQUIRED

string (email), max length: 320

Email address.

verified

boolean

Whether the email address has been verified.

dateOfBirth

string (date), format: yyyy-MM-dd

Beneficiary’s date of birth.

placeOfBirth

object

Beneficiary’s place of birth.

city

string, max length: 60

City.

countryCode

string, min length: 3, max length: 3

Country code. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA and Canada is CAN.

socialId

string, max length: 50

Beneficiary’s unique national identifier, such as a Social Security Number (SSN). Responses include a truncated value only.

socialIdCountryCode

string, min length: 3, max length: 3

Country where the social ID was granted. Required if socialId is provided. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA and Canada is CAN.

citizenshipCountryCode

string, min length: 3, max length: 3

Country where the Beneficiary holds citizenship. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA and Canada is CAN.

title

string, max length: 100

Beneficiary’s title at the business.

ownershipPercentage

number, max length: 100

Percentage of the business owned by the Beneficiary.

controller

boolean

Whether the Beneficiary exercises significant control over the business, such as the CEO, General Partner, or Treasurer.

addresses

array

Beneficiary addresses.

The Beneficiary can have multiple addresses for each address type (MAILING, PHYSICAL, and SHIPPING).
A primary address must be specified for each address type added to the Beneficiary’s profile.
- Only one primary address can be specified for each address type.
- If a primary address is not specified for an address type, the first address of this type will be set as the primary address.
- If multiple addresses exist for an address type and the primary address is removed (and another address is not explicitly set as primary), another address of the same type will be set as the primary address.

type REQUIRED

string enum, values: MAILING, PHYSICAL, SHIPPING

Type of address. The following values are supported:

MAILING Address used for mail.
PHYSICAL Physical location where the Beneficiary resides. Cannot be a post office (PO) box.
SHIPPING Address used for packages or shipments.

name CONDITIONAL

object

Name of the contact person for shipments. Required if type is SHIPPING. Ignored for other address types.

firstName REQUIRED

string, min length: 1, max length: 40

Contact person’s first name.

middleName

string, min length: 1, max length: 40

Contact person’s middle name.

lastName REQUIRED

string, min length: 1, max length: 40

Contact person’s last name.

streetLine1

string, min length: 1, max length: 50

First line of the street address.

streetLine2

string, min length: 1, max length: 50

Second line of the street address.

streetLine3

string, min length: 1, max length: 50

Third line of the street address.

streetLine4

string, min length: 1, max length: 50

Fourth line of the street address. Only used for issued cards.

streetLine5

string, min length: 1, max length: 50

Fifth line of the street address. Only used for issued cards.

apartmentNumber

string

Apartment number.

cityName

string, min length: 1, max length: 25

City.

stateCode

string, min length: 2, max length: 3

State, province, or territory. Required if country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2-character or 3-character country subdivision code (for example, Missouri is MO).

countryCode

string, min length: 3, max length: 3

Country code. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA and Canada is CAN.

zipCode CONDITIONAL

string, min length: 1, max length: 10

Zip code or postal code. Required if countryCode is USA or CAN. For US addresses, must be a valid value of 5 digits (example: 63368) or 5 digits-4 digits (example: 63368-5555). Can be alphanumeric for other countries.

primary CONDITIONAL

boolean

Whether this is the primary address for this address type. A primary address must be specified for each address type added to the Beneficiary profile.

Returns

Returns the Beneficiary object. This object contains the Beneficiary details, including a unique ID for the Beneficiary.

SAMPLE REQUEST

				
					{
  "primaryEmail": {
    "value": "nsmith@example.com",
    "verified": false
  }
}

SAMPLE RESPONSE

				
					{
  "parentId": "69248436-39f5-4074-9823-76d2580c82a6",
  "id": "997dec9d-afcb-4843-a9e3-5333b6228229",
  "firstName": "Natalie",
  "middleName": "Sue",
  "lastName": "Smith",
  "sex": "FEMALE",
  "primaryPhoneNumber": {
    "number": "+17512312345",
    "type": "MOBILE",
    "provider": "XYZ Mobile",
    "extension": "",
    "verified": false
  },
  "primaryEmail": {
    "value": "nsmith@example.com",
    "verified": false
  },
  "dateOfBirth": "1981-05-11",
  "placeOfBirth": {
    "city": "New York",
    "countryCode": "USA"
  },
  "socialId": "123-45-6789",
  "socialIdCountryCode": "USA",
  "citizenshipCountryCode": "CAN"
  "title": "CEO",
  "ownershipPercentage": "50",
  "controller": true,
  "addresses": [
    {
      "type": "MAILING",
      "streetLine1": "400 Richmond St",
      "streetLine2": "Suite 500",
      "streetLine3": "",
      "streetLine4": "",
      "streetLine5": "",
      "apartmentNumber": "",
      "cityName": "New York",
      "stateCode": "NY",
      "countryCode": "USA",
      "zipCode": "10001",
      "primary": true
    }
  ],
  "createdBy": {
    "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
    "type": "service-account"
  },
  "createdAt": "2023-05-20T00:42:50.311Z",
  "updatedBy": {
    "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
    "type": "service-account"
  },
  "updatedAt": "2023-06-12T00:42:50.311Z"
}