Beneficiary Quick Info Object

The Beneficiary Quick Info object represents a Beneficiary that has been created for a Business Customer Account. This object provides summary information for the Beneficiary.

Attributes

parentId

string (UUID)

ID of the Customer Account to which the Beneficiary belongs.

string (UUID)

ID of the Beneficiary.

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.

primaryPhoneNumber

object

Beneficiary’s primary phone number.

number

string

format: [+] [country code] [phone number including area code]

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

string enum, values: WORK, HOME, MOBILE

Type of phone number.

provider

string, max length: 40, min length: 1

Phone provider.

extension

string, max length: 10, min length: 1

Phone extension.

verified

boolean

Whether the phone number has been verified.

primaryEmail

object

Beneficiary’s primary email address.

value

string (email), max length: 320

Email address.

verified

boolean

Whether the email address has been verified.

controller

boolean

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

Beneficiary Quick Info Object

				
					{
  "parentId": "69248436-39f5-4074-9823-76d2580c82a6",
  "id": "997dec9d-afcb-4843-a9e3-5333b6228229",
  "firstName": "Natalie",
  "middleName": "Sue",
  "lastName": "Smith",
  "primaryPhoneNumber": {
    "number": "+17512312345",
    "type": "MOBILE",
    "provider": "XYZ Mobile",
    "extension": "",
    "verified": false
  },
  "primaryEmail": {
    "value": "nsmith@example.com",
    "verified": false
  },
  "controller": true
}