Skip to content

Adding an Enrollment Guide

This guide outlines the full workflow for creating the structures needed for enrollment, adding a subscriber and dependents, and assigning plan coverage. Use these steps when building end-to-end enrollment onboarding flows through VBAPI.

Step 0: Prerequisites (Groups, Contracts, Billing Cycle)

Before adding members, you must establish the group hierarchy and billing configuration they belong to. These foundational records define how the group operates and where the enrollment will be placed.

Create a BillingCycle Create a Group Create a GroupDivision Create GroupContract

Step 1: Create a Subscriber

The subscriber is the primary member of the contract. Create this record first to establish the anchor for the enrollment.

Create a Subscriber

Step 2: Create Members

After the subscriber is created, add dependent members or additional covered individuals that will be part of the enrollment.

Create a Member

Step 3: Add Enrollment

Enroll the subscriber (and optionally their dependents) into the appropriate coverage period. This connects the member records to the group contract.

Call Subscriber Add Enrollment

Step 4: Define Plans

Plans specify the actual coverage the subscriber receives. Create the plan structure and attach the selected plan(s) to the enrollment to complete the setup.

Create PlanType Create Plan Create SubEnrollmentPlan