Submit benefit elections

post/v1/employees/{employee_id}/enrollments/elect

Completes the benefits election process for all pending enrollments for an employee. Processes enrollment decisions: which benefits to enroll/waive, plan selections, and dependent coverage. Pending enrollments transition to enrolled or waived status based on elections.

Path ParametersExpand Collapse

employee_id: string

Body ParametersExpand Collapse

elections: array of object { decision, enrollment_id, coverage_tier, 2 more }

List of enrollment elections

decision: "Enrolled" or "Waived"

Enrolled - Enrolled
Waived - Waived

Accepts one of the following:

"Enrolled"

"Waived"

enrollment_id: string

ID of the enrollment (enrl_*)

coverage_tier: optional CoverageTier

Unspecified - Unspecified
EE - Ee
ES - Es
EC - Ec
EF - Ef

Accepts one of the following:

"Unspecified"

"EE"

"ES"

"EC"

"EF"

dependent_ids: optional array of string

List of dependent IDs to include in coverage (dpnd_*)

selected_plan_id: optional string

ID of the selected plan (plan_*). Required if decision is 'Enrolled'

ReturnsExpand Collapse

id: string

Unique enrollment identifier with 'enrl_' prefix

benefit_product_id: string

ID of the benefit product (bprd_*)

created_at: string

Timestamp when the enrollment was created

formatdate-time

employee_id: string

ID of the employee (empl_*)

plan_year_id: string

ID of the plan year (plyr_*)

status: EnrollmentStatus

pending - Pending
enrolled - Enrolled
waived - Waived
inactive - Inactive

Accepts one of the following:

"pending"

"enrolled"

"waived"

"inactive"

updated_at: string

Timestamp when the enrollment was last updated

formatdate-time

coverage_end_date: optional string

Date when coverage ends

formatdate

coverage_start_date: optional string

Date when coverage begins

formatdate

coverage_tier: optional CoverageTier

Unspecified - Unspecified
EE - Ee
ES - Es
EC - Ec
EF - Ef

Accepts one of the following:

"Unspecified"

"EE"

"ES"

"EC"

"EF"

decision: optional string

Employee's election decision: 'enrolled' (accepted) or 'waived' (declined)

employee_contribution_cents: optional number

Employee's monthly contribution in cents

employer_contribution_cents: optional number

Employer's monthly contribution in cents

enrolled_dependents: optional array of object { dependent_id, first_name, last_name, relationship }

List of dependents included in this enrollment

dependent_id: string

ID of the dependent (dpnd_*)

first_name: string

Dependent's first name

last_name: string

Dependent's last name

relationship: Relationship

Spouse - Spouse
Child - Child

Accepts one of the following:

"Spouse"

"Child"

selected_plan_id: optional string

ID of the selected plan (plan_*), if enrolled

selected_plan_name: optional string

Name of the selected plan

Submit benefit elections

curl https://api.vitablehealth.com/v1/employees/$EMPLOYEE_ID/enrollments/elect \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $VITABLE_connect_API_API_KEY" \
    -d '{
          "elections": [
            {
              "decision": "Enrolled",
              "enrollment_id": "enrollment_id"
            }
          ]
        }'

[
  {
    "id": "id",
    "benefit_product_id": "benefit_product_id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "employee_id": "employee_id",
    "plan_year_id": "plan_year_id",
    "status": "pending",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "coverage_end_date": "2019-12-27",
    "coverage_start_date": "2019-12-27",
    "coverage_tier": "Unspecified",
    "decision": "decision",
    "employee_contribution_cents": 0,
    "employer_contribution_cents": 0,
    "enrolled_dependents": [
      {
        "dependent_id": "dependent_id",
        "first_name": "first_name",
        "last_name": "last_name",
        "relationship": "Spouse"
      }
    ],
    "selected_plan_id": "selected_plan_id",
    "selected_plan_name": "selected_plan_name"
  }
]

Returns Examples

[
  {
    "id": "id",
    "benefit_product_id": "benefit_product_id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "employee_id": "employee_id",
    "plan_year_id": "plan_year_id",
    "status": "pending",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "coverage_end_date": "2019-12-27",
    "coverage_start_date": "2019-12-27",
    "coverage_tier": "Unspecified",
    "decision": "decision",
    "employee_contribution_cents": 0,
    "employer_contribution_cents": 0,
    "enrolled_dependents": [
      {
        "dependent_id": "dependent_id",
        "first_name": "first_name",
        "last_name": "last_name",
        "relationship": "Spouse"
      }
    ],
    "selected_plan_id": "selected_plan_id",
    "selected_plan_name": "selected_plan_name"
  }
]