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>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"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
}
}
'import requests
url = "https://api.vitablehealth.com/v1/company-benefit-enrollments/elect"
payload = {
"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>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"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
}
}
headers = {
"X-Partner-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Partner-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>',
first_name: '<string>',
last_name: '<string>',
date_of_birth: '2023-12-25',
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
}
})
};
fetch('https://api.vitablehealth.com/v1/company-benefit-enrollments/elect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vitablehealth.com/v1/company-benefit-enrollments/elect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'first_name' => '<string>',
'last_name' => '<string>',
'date_of_birth' => '2023-12-25',
'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
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Partner-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vitablehealth.com/v1/company-benefit-enrollments/elect"
payload := strings.NewReader("{\n \"elections\": [\n {\n \"enrollment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"waived_in\": true,\n \"chosen_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chosen_external_plan\": {\n \"plan_id\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"carrier\": \"<string>\"\n },\n \"waived_dependents_fake_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"dependents\": [\n {\n \"fake_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"street_address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ],\n \"signing\": {\n \"full_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_date\": \"2023-12-25\",\n \"e_sign_consent_in\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Partner-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vitablehealth.com/v1/company-benefit-enrollments/elect")
.header("X-Partner-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"elections\": [\n {\n \"enrollment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"waived_in\": true,\n \"chosen_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chosen_external_plan\": {\n \"plan_id\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"carrier\": \"<string>\"\n },\n \"waived_dependents_fake_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"dependents\": [\n {\n \"fake_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"street_address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ],\n \"signing\": {\n \"full_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_date\": \"2023-12-25\",\n \"e_sign_consent_in\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vitablehealth.com/v1/company-benefit-enrollments/elect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Partner-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"elections\": [\n {\n \"enrollment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"waived_in\": true,\n \"chosen_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chosen_external_plan\": {\n \"plan_id\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"carrier\": \"<string>\"\n },\n \"waived_dependents_fake_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"dependents\": [\n {\n \"fake_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"street_address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ],\n \"signing\": {\n \"full_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_date\": \"2023-12-25\",\n \"e_sign_consent_in\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_benefit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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"
}
]
}Enrollments
Elect benefit enrollments
Process benefit enrollment elections for employees and their dependents. Allows payroll providers to submit enrollment choices, waive benefits, add dependents, and complete the enrollment process with electronic signatures.
POST
/
v1
/
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>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"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
}
}
'import requests
url = "https://api.vitablehealth.com/v1/company-benefit-enrollments/elect"
payload = {
"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>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"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
}
}
headers = {
"X-Partner-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Partner-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>',
first_name: '<string>',
last_name: '<string>',
date_of_birth: '2023-12-25',
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
}
})
};
fetch('https://api.vitablehealth.com/v1/company-benefit-enrollments/elect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vitablehealth.com/v1/company-benefit-enrollments/elect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'first_name' => '<string>',
'last_name' => '<string>',
'date_of_birth' => '2023-12-25',
'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
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Partner-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vitablehealth.com/v1/company-benefit-enrollments/elect"
payload := strings.NewReader("{\n \"elections\": [\n {\n \"enrollment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"waived_in\": true,\n \"chosen_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chosen_external_plan\": {\n \"plan_id\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"carrier\": \"<string>\"\n },\n \"waived_dependents_fake_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"dependents\": [\n {\n \"fake_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"street_address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ],\n \"signing\": {\n \"full_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_date\": \"2023-12-25\",\n \"e_sign_consent_in\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Partner-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vitablehealth.com/v1/company-benefit-enrollments/elect")
.header("X-Partner-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"elections\": [\n {\n \"enrollment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"waived_in\": true,\n \"chosen_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chosen_external_plan\": {\n \"plan_id\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"carrier\": \"<string>\"\n },\n \"waived_dependents_fake_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"dependents\": [\n {\n \"fake_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"street_address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ],\n \"signing\": {\n \"full_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_date\": \"2023-12-25\",\n \"e_sign_consent_in\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vitablehealth.com/v1/company-benefit-enrollments/elect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Partner-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"elections\": [\n {\n \"enrollment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"waived_in\": true,\n \"chosen_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"chosen_external_plan\": {\n \"plan_id\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"carrier\": \"<string>\"\n },\n \"waived_dependents_fake_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"dependents\": [\n {\n \"fake_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"street_address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ],\n \"signing\": {\n \"full_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_date\": \"2023-12-25\",\n \"e_sign_consent_in\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_benefit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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
Partner API key for external integrations
Body
application/json
Response
200 - application/json
Enrollment elections processed successfully
Processed enrollments
Show child attributes
Show child attributes
⌘I
