Customer Beneficiary
A customer beneficiary is a person who the customer specifies should receive the funds in the event of the customer's death.
Take me to the Customer Beneficiary Endpoint Reference
customerBeneficiary Object
Property | Data type (length) | Description |
---|---|---|
addressLine1 | string (100) | |
addressLine2 | string (100) | |
addressLine3 | string (100) | |
addressLine4 | string (100) | |
birthDate | datetime | Date the customer beneficiary was born. Example:1975-07-14T00:00:00.000+00:00 |
city | string (50) | Address city |
country | string (50) | Address country |
createdDate | datetime | Date the customer was created. Note: a customer may have been created but not available for use, depending on the isLocked or status properties. |
customerBeneficiaryId | integer | Helix-assigned unique ID for the customer beneficiary |
customerId | integer | Helix-assigned unique ID for the customer to whom this beneficiary belongs |
distributionDescription | string (50) | Free-form description of the distribution |
documentsAcceptedDate | string (1) | |
emailAddress | string (256) | Example: [email protected] |
firstName | string (50) | First name of the beneficiary |
isActive | boolean | Denotes if this customer beneficiary is available for use. |
isDocumentsAccepted | boolean | Only required when creating a new customer. Confirms that customer viewed and accepted all documents returned via the /bankDocument/list route |
lastModifiedDate | datetime | Date when the object was last altered in any way |
lastName | string (50) | Last name of the beneficiary |
legalName1 | string (100) | Legal name (if beneficiary is not a person) |
legalName2 | string (100) | Legal name continued (if beneficiary is not a person) |
middleName | string (50) | Middle name of the beneficiary |
phoneNumber | string (15) | |
postalCode | string (9) | Address postal code |
state | string (2) | 2-character state code of address |
suffix | string (20) | A customer beneficiary' name suffix. Examples: - Sr. - Esq. - Ph.D |
tag | string (50) | A client-assigned unique identifier to represent exactly one customer in Helix in production. Sandbox does allow duplicate tags for testing. Typically represents the unique user ID in your system |
taxId | string (50) | Tax ID of the beneficiary |
taxIdMasked | string | Tax ID of the beneficiary with all but the last 4 characters masked |
Updated 23 days ago