cURL
curl --request POST \
--url https://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"coverages": [
{
"plan": "<string>",
"enrolled_dependents": [
{
"plan": "<string>",
"dependent": "<string>",
"primary_care_provider": {
"full_name": "<string>",
"is_existing_patient": true,
"provider_id_number": "<string>"
},
"volume": "<string>",
"requested_volume": "<string>",
"volume_approved_at": "2023-11-07T05:31:56Z",
"eoi_dismissed_at": "2023-11-07T05:31:56Z"
}
],
"waived_dependents": [
{
"dependent": "<string>"
}
],
"assign_primary_care_provider": true,
"volume": "<string>",
"tax_advantaged_account_member_contribution": "<string>"
}
]
}
'import requests
url = "https://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit"
payload = { "coverages": [
{
"plan": "<string>",
"enrolled_dependents": [
{
"plan": "<string>",
"dependent": "<string>",
"primary_care_provider": {
"full_name": "<string>",
"is_existing_patient": True,
"provider_id_number": "<string>"
},
"volume": "<string>",
"requested_volume": "<string>",
"volume_approved_at": "2023-11-07T05:31:56Z",
"eoi_dismissed_at": "2023-11-07T05:31:56Z"
}
],
"waived_dependents": [{ "dependent": "<string>" }],
"assign_primary_care_provider": True,
"volume": "<string>",
"tax_advantaged_account_member_contribution": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
coverages: [
{
plan: '<string>',
enrolled_dependents: [
{
plan: '<string>',
dependent: '<string>',
primary_care_provider: {
full_name: '<string>',
is_existing_patient: true,
provider_id_number: '<string>'
},
volume: '<string>',
requested_volume: '<string>',
volume_approved_at: '2023-11-07T05:31:56Z',
eoi_dismissed_at: '2023-11-07T05:31:56Z'
}
],
waived_dependents: [{dependent: '<string>'}],
assign_primary_care_provider: true,
volume: '<string>',
tax_advantaged_account_member_contribution: '<string>'
}
]
})
};
fetch('https://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit', 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://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit",
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([
'coverages' => [
[
'plan' => '<string>',
'enrolled_dependents' => [
[
'plan' => '<string>',
'dependent' => '<string>',
'primary_care_provider' => [
'full_name' => '<string>',
'is_existing_patient' => true,
'provider_id_number' => '<string>'
],
'volume' => '<string>',
'requested_volume' => '<string>',
'volume_approved_at' => '2023-11-07T05:31:56Z',
'eoi_dismissed_at' => '2023-11-07T05:31:56Z'
]
],
'waived_dependents' => [
[
'dependent' => '<string>'
]
],
'assign_primary_care_provider' => true,
'volume' => '<string>',
'tax_advantaged_account_member_contribution' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit"
payload := strings.NewReader("{\n \"coverages\": [\n {\n \"plan\": \"<string>\",\n \"enrolled_dependents\": [\n {\n \"plan\": \"<string>\",\n \"dependent\": \"<string>\",\n \"primary_care_provider\": {\n \"full_name\": \"<string>\",\n \"is_existing_patient\": true,\n \"provider_id_number\": \"<string>\"\n },\n \"volume\": \"<string>\",\n \"requested_volume\": \"<string>\",\n \"volume_approved_at\": \"2023-11-07T05:31:56Z\",\n \"eoi_dismissed_at\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"waived_dependents\": [\n {\n \"dependent\": \"<string>\"\n }\n ],\n \"assign_primary_care_provider\": true,\n \"volume\": \"<string>\",\n \"tax_advantaged_account_member_contribution\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"coverages\": [\n {\n \"plan\": \"<string>\",\n \"enrolled_dependents\": [\n {\n \"plan\": \"<string>\",\n \"dependent\": \"<string>\",\n \"primary_care_provider\": {\n \"full_name\": \"<string>\",\n \"is_existing_patient\": true,\n \"provider_id_number\": \"<string>\"\n },\n \"volume\": \"<string>\",\n \"requested_volume\": \"<string>\",\n \"volume_approved_at\": \"2023-11-07T05:31:56Z\",\n \"eoi_dismissed_at\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"waived_dependents\": [\n {\n \"dependent\": \"<string>\"\n }\n ],\n \"assign_primary_care_provider\": true,\n \"volume\": \"<string>\",\n \"tax_advantaged_account_member_contribution\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"coverages\": [\n {\n \"plan\": \"<string>\",\n \"enrolled_dependents\": [\n {\n \"plan\": \"<string>\",\n \"dependent\": \"<string>\",\n \"primary_care_provider\": {\n \"full_name\": \"<string>\",\n \"is_existing_patient\": true,\n \"provider_id_number\": \"<string>\"\n },\n \"volume\": \"<string>\",\n \"requested_volume\": \"<string>\",\n \"volume_approved_at\": \"2023-11-07T05:31:56Z\",\n \"eoi_dismissed_at\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"waived_dependents\": [\n {\n \"dependent\": \"<string>\"\n }\n ],\n \"assign_primary_care_provider\": true,\n \"volume\": \"<string>\",\n \"tax_advantaged_account_member_contribution\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"enrolled_plans": [
{
"id": "<string>",
"enrollment": "<string>",
"plan": "<string>",
"enrolled_dependents": [
{
"id": "<string>",
"plan": "<string>",
"dependent": "<string>",
"primary_care_provider": {
"id": "<string>",
"full_name": "<string>",
"is_existing_patient": true,
"provider_id_number": "<string>"
},
"volume": "<string>",
"requested_volume": "<string>",
"volume_approved_at": "2023-11-07T05:31:56Z",
"eoi_dismissed_at": "2023-11-07T05:31:56Z"
}
],
"primary_care_provider": {
"id": "<string>",
"full_name": "<string>",
"is_existing_patient": true,
"provider_id_number": "<string>"
},
"effective_start": "2023-12-25",
"effective_end": "2023-12-25",
"premium": "<string>",
"employer_contribution": "<string>",
"member_contribution": "<string>",
"payroll_provider_external_id": "<string>",
"volume": "<string>",
"requested_volume": "<string>",
"volume_approved_at": "2023-11-07T05:31:56Z",
"eoi_dismissed_at": "2023-11-07T05:31:56Z"
}
],
"member": "<string>",
"effective_start": "2023-12-25",
"effective_end": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"coverage_waivers": [
{
"member": "<string>",
"dependent": "<string>"
}
],
"change_date": "2023-12-25",
"qualifying_life_event_documents": [
"<string>"
],
"metadata": {}
}Enrollments
Submit Enrollment
Stages an enrollment, but does not send to carrier. You are not able to edit submitted enrollments unless you reopen it.
POST
/
enrollments
/
{public_id}
/
save_and_submit
cURL
curl --request POST \
--url https://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"coverages": [
{
"plan": "<string>",
"enrolled_dependents": [
{
"plan": "<string>",
"dependent": "<string>",
"primary_care_provider": {
"full_name": "<string>",
"is_existing_patient": true,
"provider_id_number": "<string>"
},
"volume": "<string>",
"requested_volume": "<string>",
"volume_approved_at": "2023-11-07T05:31:56Z",
"eoi_dismissed_at": "2023-11-07T05:31:56Z"
}
],
"waived_dependents": [
{
"dependent": "<string>"
}
],
"assign_primary_care_provider": true,
"volume": "<string>",
"tax_advantaged_account_member_contribution": "<string>"
}
]
}
'import requests
url = "https://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit"
payload = { "coverages": [
{
"plan": "<string>",
"enrolled_dependents": [
{
"plan": "<string>",
"dependent": "<string>",
"primary_care_provider": {
"full_name": "<string>",
"is_existing_patient": True,
"provider_id_number": "<string>"
},
"volume": "<string>",
"requested_volume": "<string>",
"volume_approved_at": "2023-11-07T05:31:56Z",
"eoi_dismissed_at": "2023-11-07T05:31:56Z"
}
],
"waived_dependents": [{ "dependent": "<string>" }],
"assign_primary_care_provider": True,
"volume": "<string>",
"tax_advantaged_account_member_contribution": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
coverages: [
{
plan: '<string>',
enrolled_dependents: [
{
plan: '<string>',
dependent: '<string>',
primary_care_provider: {
full_name: '<string>',
is_existing_patient: true,
provider_id_number: '<string>'
},
volume: '<string>',
requested_volume: '<string>',
volume_approved_at: '2023-11-07T05:31:56Z',
eoi_dismissed_at: '2023-11-07T05:31:56Z'
}
],
waived_dependents: [{dependent: '<string>'}],
assign_primary_care_provider: true,
volume: '<string>',
tax_advantaged_account_member_contribution: '<string>'
}
]
})
};
fetch('https://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit', 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://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit",
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([
'coverages' => [
[
'plan' => '<string>',
'enrolled_dependents' => [
[
'plan' => '<string>',
'dependent' => '<string>',
'primary_care_provider' => [
'full_name' => '<string>',
'is_existing_patient' => true,
'provider_id_number' => '<string>'
],
'volume' => '<string>',
'requested_volume' => '<string>',
'volume_approved_at' => '2023-11-07T05:31:56Z',
'eoi_dismissed_at' => '2023-11-07T05:31:56Z'
]
],
'waived_dependents' => [
[
'dependent' => '<string>'
]
],
'assign_primary_care_provider' => true,
'volume' => '<string>',
'tax_advantaged_account_member_contribution' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit"
payload := strings.NewReader("{\n \"coverages\": [\n {\n \"plan\": \"<string>\",\n \"enrolled_dependents\": [\n {\n \"plan\": \"<string>\",\n \"dependent\": \"<string>\",\n \"primary_care_provider\": {\n \"full_name\": \"<string>\",\n \"is_existing_patient\": true,\n \"provider_id_number\": \"<string>\"\n },\n \"volume\": \"<string>\",\n \"requested_volume\": \"<string>\",\n \"volume_approved_at\": \"2023-11-07T05:31:56Z\",\n \"eoi_dismissed_at\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"waived_dependents\": [\n {\n \"dependent\": \"<string>\"\n }\n ],\n \"assign_primary_care_provider\": true,\n \"volume\": \"<string>\",\n \"tax_advantaged_account_member_contribution\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"coverages\": [\n {\n \"plan\": \"<string>\",\n \"enrolled_dependents\": [\n {\n \"plan\": \"<string>\",\n \"dependent\": \"<string>\",\n \"primary_care_provider\": {\n \"full_name\": \"<string>\",\n \"is_existing_patient\": true,\n \"provider_id_number\": \"<string>\"\n },\n \"volume\": \"<string>\",\n \"requested_volume\": \"<string>\",\n \"volume_approved_at\": \"2023-11-07T05:31:56Z\",\n \"eoi_dismissed_at\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"waived_dependents\": [\n {\n \"dependent\": \"<string>\"\n }\n ],\n \"assign_primary_care_provider\": true,\n \"volume\": \"<string>\",\n \"tax_advantaged_account_member_contribution\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.withclasp.com/enrollments/{public_id}/save_and_submit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"coverages\": [\n {\n \"plan\": \"<string>\",\n \"enrolled_dependents\": [\n {\n \"plan\": \"<string>\",\n \"dependent\": \"<string>\",\n \"primary_care_provider\": {\n \"full_name\": \"<string>\",\n \"is_existing_patient\": true,\n \"provider_id_number\": \"<string>\"\n },\n \"volume\": \"<string>\",\n \"requested_volume\": \"<string>\",\n \"volume_approved_at\": \"2023-11-07T05:31:56Z\",\n \"eoi_dismissed_at\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"waived_dependents\": [\n {\n \"dependent\": \"<string>\"\n }\n ],\n \"assign_primary_care_provider\": true,\n \"volume\": \"<string>\",\n \"tax_advantaged_account_member_contribution\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"enrolled_plans": [
{
"id": "<string>",
"enrollment": "<string>",
"plan": "<string>",
"enrolled_dependents": [
{
"id": "<string>",
"plan": "<string>",
"dependent": "<string>",
"primary_care_provider": {
"id": "<string>",
"full_name": "<string>",
"is_existing_patient": true,
"provider_id_number": "<string>"
},
"volume": "<string>",
"requested_volume": "<string>",
"volume_approved_at": "2023-11-07T05:31:56Z",
"eoi_dismissed_at": "2023-11-07T05:31:56Z"
}
],
"primary_care_provider": {
"id": "<string>",
"full_name": "<string>",
"is_existing_patient": true,
"provider_id_number": "<string>"
},
"effective_start": "2023-12-25",
"effective_end": "2023-12-25",
"premium": "<string>",
"employer_contribution": "<string>",
"member_contribution": "<string>",
"payroll_provider_external_id": "<string>",
"volume": "<string>",
"requested_volume": "<string>",
"volume_approved_at": "2023-11-07T05:31:56Z",
"eoi_dismissed_at": "2023-11-07T05:31:56Z"
}
],
"member": "<string>",
"effective_start": "2023-12-25",
"effective_end": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"coverage_waivers": [
{
"member": "<string>",
"dependent": "<string>"
}
],
"change_date": "2023-12-25",
"qualifying_life_event_documents": [
"<string>"
],
"metadata": {}
}Authorizations
API Key authentication with required prefix "Bearer"
Path Parameters
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Show child attributes
Show child attributes
Response
200 - application/json
Pattern:
^[-a-zA-Z0-9_]+$Show child attributes
Show child attributes
qle- Qleopen_enrollment- Open Enrollmentcarrier_sync- Carrier Sync
Available options:
qle, open_enrollment, carrier_sync not_started- Not Startedpending- Pendingapproved- Approvedsynced- Syncedcancelled- Cancelledfailed- Failed
Available options:
not_started, pending, approved, synced, cancelled, failed Show child attributes
Show child attributes
new_child- New Childadopted_child- Adopted Childmarriage- Marriagedependent_lost_coverage- Dependent Lost Coveragedependent_gained_coverage- Dependent Gained Coveragedependent_relocated_in_network- Dependent Relocated In Networkdependent_court_order- Dependent Court Orderdivorce- Divorcedomestic_partnership- Domestic Partnershiprelocated- Relocatedlost_coverage- Lost Coveragedeath- Deathnew_hire- New Hireterminated- Terminatedrehire- Rehireleave_of_absence- Leave Of Absenceopen_enrollment- Open Enrollmentpassive_open_enrollment- Passive Open Enrollmentemployment_change- Employment Changedependent_employment_change- Dependent Employment Changenew_eligibility- New Eligibilitygain_coverage- Gain Coveragesignificant_plan_change- Significant Plan Changedependent_aged_out- Dependent Aged Outcitizenship_change- Citizenship Changerelease_from_incarceration- Release From Incarcerationtax_advantaged_contribution_change- Tax Advantaged Contribution Change
Available options:
new_child, adopted_child, marriage, dependent_lost_coverage, dependent_gained_coverage, dependent_relocated_in_network, dependent_court_order, divorce, carrier_sync, domestic_partnership, relocated, lost_coverage, death, new_hire, terminated, rehire, leave_of_absence, open_enrollment, passive_open_enrollment, employment_change, dependent_employment_change, new_eligibility, gain_coverage, significant_plan_change, dependent_aged_out, citizenship_change, release_from_incarceration, tax_advantaged_contribution_change Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.
Show child attributes
Show child attributes
⌘I