# Enrollment

An Enrollment represents programs the account may enroll in.

## Example Usage

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

let value: Enrollment = {};
```

## Fields

| Field                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                   | Required                                                                                                                                                                                                               | Description                                                                                                                                                                                                            | Example                                                                                                                                                                                                                |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `beneficiaryEnrollmentMetadata`                                                                                                                                                                                        | [components.BeneficiaryEnrollmentMetadata](../../models/components/beneficiaryenrollmentmetadata.md)                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the BENEFICIARY_DESIGNATION enrollment type.                                                                                                                                                              |                                                                                                                                                                                                                        |
| `consentMethod`                                                                                                                                                                                                        | [components.ConsentMethod](../../models/components/consentmethod.md)                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                     | The consent method for the enrollment. Defaults to ESIGNATURE.                                                                                                                                                         | NEGATIVE_CONSENT_CONVERSION                                                                                                                                                                                            |
| `corporationEnrollmentMetadata`                                                                                                                                                                                        | [components.CorporationEnrollmentMetadata](../../models/components/corporationenrollmentmetadata.md)                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the REGISTRATION_CORPORATION type                                                                                                                                                                         |                                                                                                                                                                                                                        |
| `custodialEnrollmentMetadata`                                                                                                                                                                                          | [components.CustodialEnrollmentMetadata](../../models/components/custodialenrollmentmetadata.md)                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the REGISTRATION_CUSTODIAL type                                                                                                                                                                           |                                                                                                                                                                                                                        |
| `enrollmentId`                                                                                                                                                                                                         | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | A system-generated unique identifier referencing a single instance of an enrollment; Used to access the record after creation                                                                                          | 22951598-70e2-46f1-bb32-38e8da7a5cdb                                                                                                                                                                                   |
| `enrollmentTime`                                                                                                                                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                     | The time all enrollment requirements were satisfied and the enrollment transitioned to `ACTIVE`                                                                                                                        |                                                                                                                                                                                                                        |
| `estateEnrollmentMetadata`                                                                                                                                                                                             | [components.EstateEnrollmentMetadata](../../models/components/estateenrollmentmetadata.md)                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the REGISTRATION_ESTATE enrollment type                                                                                                                                                                   |                                                                                                                                                                                                                        |
| `foreignIndividualAccountEnrollmentMetadata`                                                                                                                                                                           | [components.ForeignIndividualAccountEnrollmentMetadata](../../models/components/foreignindividualaccountenrollmentmetadata.md)                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the REGISTRATION_INDIVIDUAL_FOREIGN type                                                                                                                                                                  |                                                                                                                                                                                                                        |
| `foreignJointAccountEnrollmentMetadata`                                                                                                                                                                                | [components.ForeignJointAccountEnrollmentMetadata](../../models/components/foreignjointaccountenrollmentmetadata.md)                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the REGISTRATION_JOINT_FOREIGN_WROS type                                                                                                                                                                  |                                                                                                                                                                                                                        |
| `fpslEnrollmentMetadata`                                                                                                                                                                                               | [components.FpslEnrollmentMetadata](../../models/components/fpslenrollmentmetadata.md)                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the FULLY_PAID_STOCK_LENDING enrollment type                                                                                                                                                              |                                                                                                                                                                                                                        |
| `futuresEnrollmentMetadata`                                                                                                                                                                                            | [components.FuturesEnrollmentMetadata](../../models/components/futuresenrollmentmetadata.md)                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the REGISTRATION_FUTURES enrollment type                                                                                                                                                                  |                                                                                                                                                                                                                        |
| `individualEnrollmentMetadata`                                                                                                                                                                                         | [components.IndividualEnrollmentMetadata](../../models/components/individualenrollmentmetadata.md)                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the INDIVIDUAL enrollment type                                                                                                                                                                            |                                                                                                                                                                                                                        |
| `iraBeneficiaryEnrollmentMetadata`                                                                                                                                                                                     | [components.IraBeneficiaryEnrollmentMetadata](../../models/components/irabeneficiaryenrollmentmetadata.md)                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the REGISTRATION_IRA_BENEFICIARY_ROTH and REGISTRATION_IRA_BENEFICIARY_TRADITIONAL enrollment type                                                                                                        |                                                                                                                                                                                                                        |
| `iraRolloverEnrollmentMetadata`                                                                                                                                                                                        | [components.IraRolloverEnrollmentMetadata](../../models/components/irarolloverenrollmentmetadata.md)                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the ROLLOVER_IRA_REGISTRATION enrollment type                                                                                                                                                             |                                                                                                                                                                                                                        |
| `iraRothEnrollmentMetadata`                                                                                                                                                                                            | [components.IraRothEnrollmentMetadata](../../models/components/irarothenrollmentmetadata.md)                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the ROTH_IRA_REGISTRATION enrollment type                                                                                                                                                                 |                                                                                                                                                                                                                        |
| `iraSepEnrollmentMetadata`                                                                                                                                                                                             | [components.IraSepEnrollmentMetadata](../../models/components/irasepenrollmentmetadata.md)                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the SEP_IRA_REGISTRATION enrollment type                                                                                                                                                                  |                                                                                                                                                                                                                        |
| `iraSimpleEnrollmentMetadata`                                                                                                                                                                                          | [components.IraSimpleEnrollmentMetadata](../../models/components/irasimpleenrollmentmetadata.md)                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the SIMPLE_IRA_REGISTRATION enrollment type                                                                                                                                                               |                                                                                                                                                                                                                        |
| `iraTraditionalEnrollmentMetadata`                                                                                                                                                                                     | [components.IraTraditionalEnrollmentMetadata](../../models/components/iratraditionalenrollmentmetadata.md)                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the TRADITIONAL_IRA_REGISTRATION enrollment type                                                                                                                                                          |                                                                                                                                                                                                                        |
| `jointCommunityPropertyEnrollmentMetadata`                                                                                                                                                                             | [components.JointCommunityPropertyEnrollmentMetadata](../../models/components/jointcommunitypropertyenrollmentmetadata.md)                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the JOINT_COMMUNITY_PROPERTY_REGISTRATION enrollment type                                                                                                                                                 |                                                                                                                                                                                                                        |
| `jointTenantsByEntiretyEnrollmentMetadata`                                                                                                                                                                             | [components.JointTenantsByEntiretyEnrollmentMetadata](../../models/components/jointtenantsbyentiretyenrollmentmetadata.md)                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the JOINT_TENANTS_BY_ENTIRETY_REGISTRATION enrollment type                                                                                                                                                |                                                                                                                                                                                                                        |
| `jointTenantsInCommonEnrollmentMetadata`                                                                                                                                                                               | [components.JointTenantsInCommonEnrollmentMetadata](../../models/components/jointtenantsincommonenrollmentmetadata.md)                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the JOINT_TENANTS_IN_COMMON_REGISTRATION enrollment type                                                                                                                                                  |                                                                                                                                                                                                                        |
| `jointWithRightsOfSurvivorshipEnrollmentMetadata`                                                                                                                                                                      | [components.JointWithRightsOfSurvivorshipEnrollmentMetadata](../../models/components/jointwithrightsofsurvivorshipenrollmentmetadata.md)                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the JOINT_WITH_RIGHTS_OF_SURVIVORSHIP_REGISTRATION enrollment type                                                                                                                                        |                                                                                                                                                                                                                        |
| `llcEnrollmentMetadata`                                                                                                                                                                                                | [components.LlcEnrollmentMetadata](../../models/components/llcenrollmentmetadata.md)                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the REGISTRATION_LLC type                                                                                                                                                                                 |                                                                                                                                                                                                                        |
| `name`                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | The name field Format: accounts/{account}/enrollments/{enrollment}                                                                                                                                                     | accounts/01HC3MAQ4DR9QN1V8MJ4CN1HMK/enrollments/22951598-70e2-46f1-bb32-38e8da7a5cdb                                                                                                                                   |
| `operatingEnrollmentMetadata`                                                                                                                                                                                          | [components.OperatingEnrollmentMetadata](../../models/components/operatingenrollmentmetadata.md)                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the REGISTRATION_OPERATING enrollment type.                                                                                                                                                               |                                                                                                                                                                                                                        |
| `ordersOptionsTradingEnrollmentMetadata`                                                                                                                                                                               | [components.OrdersOptionsTradingEnrollmentMetadata](../../models/components/ordersoptionstradingenrollmentmetadata.md)                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the ORDERS_OPTIONS_TRADING enrollment type                                                                                                                                                                |                                                                                                                                                                                                                        |
| `principalApproverId`                                                                                                                                                                                                  | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | The ULID is associated with the approver of a given enrollment. The approver you create will contain the CRD Number issued to the person by FINRA. As an RIA, you should use the ULID associated with Apex's approver. | 02HB7N66WW02WL3B6B9W29K0HW                                                                                                                                                                                             |
| `state`                                                                                                                                                                                                                | [components.EnrollmentState](../../models/components/enrollmentstate.md)                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Indicates where in the enrollment is in the process; May be `PENDING_AGREEMENT`, `ACTIVE`, `INACTIVE`, `PROCESSING`, or `EXPIRED`                                                                                      | ACTIVE                                                                                                                                                                                                                 |
| `trustEnrollmentMetadata`                                                                                                                                                                                              | [components.TrustEnrollmentMetadata](../../models/components/trustenrollmentmetadata.md)                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the REGISTRATION_TRUST type                                                                                                                                                                               |                                                                                                                                                                                                                        |
| `type`                                                                                                                                                                                                                 | [components.EnrollmentType1](../../models/components/enrollmenttype1.md)                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Describes the name of the enrollment; Expressed as an enum                                                                                                                                                             | REGISTRATION_INDIVIDUAL                                                                                                                                                                                                |
| `unenrollmentTime`                                                                                                                                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                     | The time an unenrollment request was processed and the enrollment transitioned to `INACTIVE`                                                                                                                           |                                                                                                                                                                                                                        |
| `virtualAccountNumberEnrollmentMetadata`                                                                                                                                                                               | [components.VirtualAccountNumberEnrollmentMetadata](../../models/components/virtualaccountnumberenrollmentmetadata.md)                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                     | Metadata for the VIRTUAL_ACCOUNT_NUMBER type                                                                                                                                                                           |                                                                                                                                                                                                                        |