Clasp Docs

API Reference

Homepage

Support

Retrieves a list of all employers that are defined under your provider.

List Employers

* `AL` - AL
* `AK` - AK
* `AZ` - AZ
* `AR` - AR
* `CA` - CA
* `CO` - CO
* `CT` - CT
* `DE` - DE
* `DC` - DC
* `FL` - FL
* `GA` - GA
* `HI` - HI
* `ID` - ID
* `IL` - IL
* `IN` - IN
* `IA` - IA
* `KS` - KS
* `KY` - KY
* `LA` - LA
* `ME` - ME
* `MD` - MD
* `MA` - MA
* `MI` - MI
* `MN` - MN
* `MS` - MS
* `MO` - MO
* `MT` - MT
* `NE` - NE
* `NV` - NV
* `NH` - NH
* `NJ` - NJ
* `NM` - NM
* `NY` - NY
* `NC` - NC
* `ND` - ND
* `OH` - OH
* `OK` - OK
* `OR` - OR
* `PA` - PA
* `RI` - RI
* `SC` - SC
* `SD` - SD
* `TN` - TN
* `TX` - TX
* `UT` - UT
* `VT` - VT
* `VA` - VA
* `WA` - WA
* `WV` - WV
* `WI` - WI
* `WY` - WY

tokenAuth

Building an employee benefits product with Clasp

Overview

Embed benefits administration in a few easy steps

Quickstart

List of carriers and plan types supported by Clasp

Carrier Coverage

You can integrate with Clasp using our SDK

Employer Component

Employee Component

Clasp gives you complete control over the look and feel of the components your embedding

Component Styling

Component Page Navigation

Authentication

Error Handling

Pagination

Rate Limiting

Webhooks

Generates an access token to read/write the resources that belong to an employer.

Get Employer Access Token

Generates an access token to read/write the resources that belong to a member.

Get Member Access Token

List Carriers

Retrieve Carrier

Generates a magic link to a portal used by employers to view and manage their company's benefits. Magic links can be embedded directly into your product via iFrame.

Employer Admin

Generates a magic link to a portal used by employees to view and manage their benefits. Magic links can be embedded directly into your product via iFrame.

Member Admin

Lists all active carrier connections under your provider.

List Connections

Retrieves details for a single carrier connection.

Retrieve Connection

Generates a 1095-C form for all employees under that connection.

Preview 1095-C Forms

Creates mock data for testing in development that would typically be pulled from the carriers.

Simulate Carrier Connections (Sandbox)

This should be called when the employer has reviewed all the plans
and members we pulled from carriers to confirm that it's correct. 

Submit Review

Lists all dependents under your provider.

List Dependents

Creates a dependent and associates it to a member.

Create Dependent

Retrieve Dependent

Delete Dependent

Update Dependent

Reveals the unmasked SSN for the given dependent id.

Reveal SSN

Retrieves the full list of every document uploaded.

List Employer Documents

Adds a document and associates it to the specified employer.

Create Employer Document

Retrieve Employer Document

Permanently deletes the employer document.

Delete Employer Document

Updates the employer document. You must pass a URL of the uploaded document in the file field (e.g., S3).

Update Employer Document

Create Employer

Retrieves a single employer object by employer id.

Retrieve Employer

Permanently deletes the employer and all objects assocaited with that employer (e.g., members, plans, etc).

Delete Employer

Update Employer

Lists all enrollments under your provider.

List Enrollments

Retrieve Enrollment

Lists all eligible plans under an enrollment.

Eligible Plans

Stages an enrollment, but does not send to carrier. You are not able to edit submitted enrollments unless you reopen it.

Submit Enrollment

Reopens a submitted enrollment to make changes.

Reopen Enrollment

Approves a submitted enrollment and sends it to the carrier.

Approve Enrollment

Permanently deletes an enrollment. This should only be used when you are sure you want to remove an enrollment. Otherwise, we recommend just reopening it using the reopen endpoint.

Delete Enrollment

List Group Connections

Create an instance of a group connection with a carrier.

Create Group Connection

Retrieve Group Connection

Updates and replaces an entire group connection.

Update Group Connection

Permanently deletes an entire group connection.

Delete Group Connection

List Members

Defines a member in Clasp. Memebers are the primary policy holder (i.e., the employee receiving benefits).

Create Member

Retrieve Member

Permanently deletes a member from Clasp. Do not use this if you are simply terminiating employee. You must update their termination_date instead.  Only use this if you no longer want their record to exist (e.g., entry error).

Delete Member

Update Member

Triggers the start of a members open enrollment.

Start Open Enrollment

Creates a qualified life event (QLE) for a member. This will create an enrollment object that needs to be approved and submitted to the carrier.

Create Qualifying Life Event

Reveals the unmasked SSN for the given member id.

List all pay rates that have been created

List Pay Pay Rates

Defines a pay rate in Clasp. Pay rates define the annual salary/hourly wage for a given Member. Note: New pay rates must be created with an effective_start date later than all existing pay_rates

Create Pay Rate

Retrieve Pay Rate

Delete Pay Rate

Update a pay rate. Note: effective_start dates may not be updated to cross existing pay rates.

Update Pay Rate

Returns a list of all payroll benefit deductions.

List Payroll Benefits

Retrieves a single payroll benefit deduction.

Retrieve Payroll Benefit

Updates a single payroll benefit deduction. Commonly used to link benefits between Clasp and the payroll provider.

Update Payroll Benefit

List Groups

Retrieve Group

Update Group

Create Group

List Plans

Retrieve Plan

Update Plan

Create Plan

Lists all plan configurations under your provider.

List Plan Configurations

Retrieves details for a single plan configuration.

Retrieve Plan Configuration

Create Plan Configuration

Retrieves the contribution strategy for a given plan.

Retrieve Contribution Strategy

Defines a contribution strategy for a given plan.

Define Contribution Strategy

Lists all subclasses under your provider.

List Subclasses

Create Subclass

Retrieves the details of a single subclass.

Retrieve Subclass

Permanently deletes the defined subclass.

Delete Subclass

Update Subclass

Lists all tasks for a given provider. Use the completed query parameter to filter between outstanding and completed tasks.

List Tasks

Defines a task in Clasp. Tasks are usually created automatically based on events that occur (e.g., QLE, new hire, etc).

Create Task

Retrieve Task

Delete Task

Updates a task. Most commonly used to update the completed_at field when the task is complete.

Update Task

Generates a report containing demographic and election information for employees and their dependents.

API Reference

List Employers

Authorizations

Query Parameters

Response