Elect benefit enrollments

curl --request POST \
  --url https://api.vitablehealth.com/v1/company-benefit-enrollments/elect \
  --header 'Content-Type: application/json' \
  --header 'X-Partner-API-Key: <api-key>' \
  --data '
{
  "elections": [
    {
      "enrollment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "waived_in": true,
      "chosen_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chosen_external_plan": {
        "plan_id": "<string>",
        "plan_name": "<string>",
        "carrier": "<string>"
      },
      "waived_dependents_fake_ids": [
        "<string>"
      ]
    }
  ],
  "dependents": [
    {
      "fake_id": "<string>",
      "type": "spouse",
      "first_name": "<string>",
      "last_name": "<string>",
      "date_of_birth": "2023-12-25",
      "suffix": "Jr.",
      "email": "<string>",
      "phone": "<string>",
      "address": {
        "street_address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip_code": "<string>"
      }
    }
  ],
  "signing": {
    "full_name": "<string>",
    "signature": "<string>",
    "signature_date": "2023-12-25",
    "e_sign_consent_in": true
  }
}
'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_benefit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "enrollment_status": "Unanswered",
      "plan_name": "<string>",
      "tier_name": "<string>",
      "employee_premium": 123,
      "employer_contribution": 123,
      "coverage_start_date": "2023-12-25",
      "coverage_end_date": "2023-12-25",
      "enrollment_date": "2023-11-07T05:31:56Z"
    }
  ]
}

POST

company-benefit-enrollments

elect

Elect benefit enrollments

curl --request POST \
  --url https://api.vitablehealth.com/v1/company-benefit-enrollments/elect \
  --header 'Content-Type: application/json' \
  --header 'X-Partner-API-Key: <api-key>' \
  --data '
{
  "elections": [
    {
      "enrollment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "waived_in": true,
      "chosen_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chosen_external_plan": {
        "plan_id": "<string>",
        "plan_name": "<string>",
        "carrier": "<string>"
      },
      "waived_dependents_fake_ids": [
        "<string>"
      ]
    }
  ],
  "dependents": [
    {
      "fake_id": "<string>",
      "type": "spouse",
      "first_name": "<string>",
      "last_name": "<string>",
      "date_of_birth": "2023-12-25",
      "suffix": "Jr.",
      "email": "<string>",
      "phone": "<string>",
      "address": {
        "street_address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip_code": "<string>"
      }
    }
  ],
  "signing": {
    "full_name": "<string>",
    "signature": "<string>",
    "signature_date": "2023-12-25",
    "e_sign_consent_in": true
  }
}
'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_benefit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "enrollment_status": "Unanswered",
      "plan_name": "<string>",
      "tier_name": "<string>",
      "employee_premium": 123,
      "employer_contribution": 123,
      "coverage_start_date": "2023-12-25",
      "coverage_end_date": "2023-12-25",
      "enrollment_date": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

X-Partner-API-Key

string

header

required

Partner API key for external integrations

Body

application/json

elections

object[]

required

Benefit election choices

Show child attributes

elections.enrollment_id

string<uuid>

required

Unique enrollment identifier

elections.waived_in

boolean

required

Whether coverage was waived

elections.chosen_item_id

string<uuid> | null

Selected plan or option identifier

elections.chosen_external_plan

object

External plan selection data

Show child attributes

elections.chosen_external_plan.plan_id

string

required

External plan identifier

elections.chosen_external_plan.plan_name

string

required

External plan name

elections.chosen_external_plan.carrier

string

Insurance carrier name

elections.waived_dependents_fake_ids

string[]

List of dependents who waived coverage

dependents

object[]

required

Dependent information for enrollment

Show child attributes

dependents.fake_id

string

required

Temporary identifier for the dependent

dependents.type

enum<string>

required

Type of dependent relationship

Available options:

spouse,

child,

domestic_partner

dependents.first_name

string

required

Dependent's first name

dependents.last_name

string

required

Dependent's last name

dependents.date_of_birth

string<date>

required

Dependent's date of birth

dependents.suffix

enum<string>

Name suffix

Available options:

Jr.,

Sr.,

II,

III,

IV

dependents.email

string | null

Dependent's email address

dependents.phone

string | null

Dependent's phone number

dependents.address

object

Dependent's address

Show child attributes

dependents.address.street_address

string

dependents.address.city

string

dependents.address.state

string

dependents.address.zip_code

string

signing

object

required

Electronic signature information

Show child attributes

signing.full_name

string

required

Signer full name

signing.signature

string

required

Electronic signature

signing.signature_date

string<date>

required

Date of signature

Electronic signature consent

Response

200 - application/json

Enrollment elections processed successfully

data

object[]

Processed enrollments

Show child attributes

data.id

string<uuid>

Unique enrollment identifier

data.company_benefit_id

string<uuid>

Associated benefit plan ID

data.company_member_id

string<uuid>

Associated employee ID

data.enrollment_status

enum<string>

Current enrollment status

Available options:

Unanswered,

Enrolled,

Waived

data.plan_name

string

Selected benefit plan name

data.tier_name

string

Selected coverage tier

data.employee_premium

integer

Employee premium amount in cents

data.employer_contribution

integer

Employer contribution in cents

data.coverage_start_date

string<date>

Coverage effective date

data.coverage_end_date

string<date>

Coverage termination date

data.enrollment_date

string<date-time>

Date enrollment was completed

List enrollments for a specific benefit plan Submit a qualifying life event

⌘I

Introduction

Benefits

Employees

Enrollments

Member Benefits

Benefit Eligibility

Payroll Integration

Quoting

Elect benefit enrollments

Authorizations

Body

Response