# Beneficiary

The beneficiary for transfer on death.

## Example Usage

```typescript
import { Beneficiary } from "@apexfintechsolutions/ascend-sdk/models/components";

let value: Beneficiary = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Required                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Example                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `beneficiaryPercentage`                                                                                                                                                                                                                                                                                                                                                                                                                                            | *number*                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | An integer conveying the percentage of interest the related Beneficiary has in the account if the owner(s) become deceased; The sum of all beneficiary percentages must equal "100"                                                                                                                                                                                                                                                                                | 100                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `birthDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [components.BeneficiaryBirthDate](../../models/components/beneficiarybirthdate.md)                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | The legal day, month, and year of birth for a beneficiary; Birth date is required if tax id and tax id type is not provided.                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `email`                                                                                                                                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Beneficiaries may provide an email, a mailing_address, or both An email address indicated for account communications                                                                                                                                                                                                                                                                                                                                               | example@email.com                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `entityName`                                                                                                                                                                                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | The legal entity name; Required if the beneficiary is a legal entity.                                                                                                                                                                                                                                                                                                                                                                                              | Acme, Inc.                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `entityType`                                                                                                                                                                                                                                                                                                                                                                                                                                                       | [components.BeneficiaryEntityType](../../models/components/beneficiaryentitytype.md)                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | The entity type of the beneficiary; Required if the beneficiary is a legal entity.                                                                                                                                                                                                                                                                                                                                                                                 | CORPORATION                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `familyName`                                                                                                                                                                                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Family name of a natural person; Required if the beneficiary is a natural person.                                                                                                                                                                                                                                                                                                                                                                                  | Smith                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `givenName`                                                                                                                                                                                                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | The given name of a natural person; Conventionally known as 'first name' in most English-speaking countries.Required if the beneficiary is a natural person.                                                                                                                                                                                                                                                                                                       | Bob                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `mailingAddress`                                                                                                                                                                                                                                                                                                                                                                                                                                                   | [components.MailingAddress](../../models/components/mailingaddress.md)                                                                                                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | The object containing data for the purpose of delivery physical mailings to a party; Typically used for statements, account updates, tax documents, and other postal mailings; May also be used as an alternative identity verification address to personalAddress. Required fields within the `mailing_address` object include:<br/> - `administrative_area`<br/> - `region_code` - 2 character CLDR Code<br/> - `postal_code`<br/> - `locality`<br/> - `address_lines` - max 5 lines |                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `middleNames`                                                                                                                                                                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Non-primary names representing a natural person; Name attributed to a person other than "Given" and "Family" names.                                                                                                                                                                                                                                                                                                                                                | Robert                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `phoneNumber`                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [components.BeneficiaryPhoneNumber](../../models/components/beneficiaryphonenumber.md)                                                                                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | The phone number for a party; Lives on the party record in the context of the account and does not commute to other accounts held by/for the person                                                                                                                                                                                                                                                                                                                | 555-555-5555                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `relationType`                                                                                                                                                                                                                                                                                                                                                                                                                                                     | [components.BeneficiaryRelationType](../../models/components/beneficiaryrelationtype.md)                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | The relationship of the beneficiary to the account owner                                                                                                                                                                                                                                                                                                                                                                                                           | SPOUSE                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `taxId`                                                                                                                                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | The full U.S. tax ID for a related person; Tax ID is required if birth date is not provided.                                                                                                                                                                                                                                                                                                                                                                       | 123456789                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `taxIdType`                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [components.BeneficiaryTaxIdType](../../models/components/beneficiarytaxidtype.md)                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                 | The nature of the U.S. Tax ID indicated in the related tax_id field; Examples include ITIN, SSN, EIN. Tax id type is required if birth date is not provided.                                                                                                                                                                                                                                                                                                       | SSN                                                                                                                                                                                                                                                                                                                                                                                                                                                                |