The Beneficiary object represents a Beneficiary that has been created for a Business Customer Account. This object provides detailed information for the Beneficiary.
parentId
string (UUID)
ID of the Customer Account to which the Beneficiary belongs.
id
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.
sex
string enum, values: MALE, FEMALE, NONBINARY
Beneficiary’s sex.
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:
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, 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
string (email), max length: 320
Email address.
verified
boolean
Whether the email address has been verified.
dateOfBirth
string (date)
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.
type
string enum, values: MAILING, PHYSICAL, SHIPPING
Type of address. The following values are supported:
name
object
Name of the contact person for shipments. Required if type is SHIPPING. Ignored for other address types.
firstName
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
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.
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
string, min length: 1, max length: 10
Zip code or postal code.
primary
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.
createdBy
string
Entity that created the Beneficiary.
id
string (UUID)
ID of the entity. Will be blank if createdBy.type is internal.
type
string enum, values: employee, service-account, internal
Type of entity. The following values are supported:
createdAt
string (date-time)
Date and time the Beneficiary was created in the RocketKOR system.
updatedBy
string
Entity that last updated the Beneficiary.
id
string (UUID)
ID of the entity. Will be blank if updatedBy.type is internal.
type
string enum, values: employee, service-account, internal
Type of entity. The following values are supported:
updatedAt
string (date-time)
Date and time the Beneficiary was last updated.
Beneficiary Object
{
"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": "",
"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"
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.