# Subscriber Add Enrollment

Adds enrollments to an existing subscriber. Can add enrollment for the subscriber or subscriber + all members.

Endpoint: POST /subscribers/{subscriberID}/add-enrollment
Version: v1
Security: apiKeyAuth, bearerAuth

## Security:

  - `apiKeyAuth` (unknown)
    apiKey in header x-api-key

  - `bearerAuth` (unknown)
    http bearer JWT

## Path parameters:

  - `subscriberID` (string, required)
    Subscriber ID

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Request fields (application/json):

  - `requesting_User_ID` (string, required)
    User ID of the person making this request.

  - `addMembers` (boolean)
    Flag indicating if members should be enrolled in addition to the subscriber.  If false, only subscriber is enrolled; If true, members + subscriber is enrolled.

  - `subEnrollment` (object)

  - `subEnrollment.subscriber_ID` (string, required)
    References Subscribers.Subscriber_ID value on the parent record.

  - `subEnrollment.group_ID` (string, required)
    References the GroupContract.Group_ID value in the parent table.

  - `subEnrollment.division_ID` (string, required)
    References the GroupContract.Division_ID value in the parent table.

  - `subEnrollment.group_Coverage_Start` (string, required)
    References the GroupContract.Coverage_Start value in the parent table.

  - `subEnrollment.start_Date` (string, required)
    Start date of Subenrollment coverage.

  - `subEnrollment.annual_Max` (number)
    Annual maximum for identified policy. [Informational Only]

  - `subEnrollment.date_Employed` (string)
    Start date of the Subscriber's employment.

  - `subEnrollment.eligibility_Date` (string)
    Date the Subscriber was eligible for coverage.

  - `subEnrollment.end_Date` (string)
    End date of Subenrollment coverage.

  - `subEnrollment.entry_Date` (string)
    Date when the record was first added to the system.

  - `subEnrollment.entry_User` (string)
    User that first added the record to the system.

  - `subEnrollment.lifetime_Max` (number)
    Lifetime maximum for indentified policy. [Informational Only]

  - `subEnrollment.original_Enrollment_Date` (string)
    Identifies the date the Enrollment began. This is useful if a new Group is added and insured Members have been covered under the Group Plan earlier than their start date with you.

  - `subEnrollment.paid_Through` (string)
    Date that the premiums have been paid through. This field will auto populate with the most recent closed invoice ‘Bill Thru’ date if 'Set Paid Thru' is set through the Control Panel. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date.

  - `subEnrollment.policy_Number` (string)
    Policy number issued from Insurer. [Informational Only]

  - `subEnrollment.term_Date` (string)
    Termination date of the Subscriber's employment.

  - `subEnrollment.update_Date` (string)
    Date when the record was last updated in the system.

  - `subEnrollment.update_User` (string)
    User that last updated the record in the system.

  - `subEnrollment.retro_Start_Date` (string)
    Original Start_Date retained when the enrollment start is moved later via Modify Enrollment, so retro adjustments
can be identified for the vacated period. Read-only for API clients: populated on GET, ignored on create/update,
and set by the EnrollmentServiceChangeSubenrollment stored procedure.

## Response 202:

  - `202` (unknown)
    Accepted

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 403:

  - `403` (unknown)
    Forbidden. The x-api-key header is missing or not valid. The API gateway sends this response, not VBAPI, so the body is not the VBAPI envelope; see Errors and troubleshooting.

## Response 429:

  - `429` (unknown)
    Too many requests. The limit is 25 requests per second sustained, with bursts up to 50, per API key. Wait and retry with exponential backoff and jitter.