# Clasp Docs

## Docs

- [SDK](https://docs.withclasp.com/SDK.md): Steps to embed the Clasp Employer and Employee Component via iFrame.
- [Delete Beneficiary](https://docs.withclasp.com/api-reference/beneficiaries/delete-beneficiaries.md)
- [List Beneficiaries](https://docs.withclasp.com/api-reference/beneficiaries/get-beneficiaries.md)
- [Retrieve Beneficiary](https://docs.withclasp.com/api-reference/beneficiaries/get-beneficiaries-1.md)
- [Reveal TIN](https://docs.withclasp.com/api-reference/beneficiaries/get-beneficiaries-reveal_tin.md)
- [Update Beneficiary](https://docs.withclasp.com/api-reference/beneficiaries/patch-beneficiaries.md)
- [Create Beneficiary](https://docs.withclasp.com/api-reference/beneficiaries/post-beneficiaries.md)
- [Delete Beneficiary Allocation](https://docs.withclasp.com/api-reference/beneficiary_allocations/delete-beneficiary_allocations.md)
- [List Beneficiary Allocations](https://docs.withclasp.com/api-reference/beneficiary_allocations/get-beneficiary_allocations.md)
- [Retrieve Beneficiary Allocation](https://docs.withclasp.com/api-reference/beneficiary_allocations/get-beneficiary_allocations-1.md)
- [Update Beneficiary Allocation](https://docs.withclasp.com/api-reference/beneficiary_allocations/patch-beneficiary_allocations.md)
- [Create Beneficiary Allocation](https://docs.withclasp.com/api-reference/beneficiary_allocations/post-beneficiary_allocations.md)
- [Delete Business Unit](https://docs.withclasp.com/api-reference/business_units/delete-business_units.md)
- [List Business Units](https://docs.withclasp.com/api-reference/business_units/get-business_units.md)
- [Retrieve Business Unit](https://docs.withclasp.com/api-reference/business_units/get-business_units-1.md)
- [Update Business Unit](https://docs.withclasp.com/api-reference/business_units/patch-business_units.md)
- [Create Business Unit](https://docs.withclasp.com/api-reference/business_units/post-business_units.md)
- [List Carriers](https://docs.withclasp.com/api-reference/carriers/get-carriers.md): Lists all carriers supported by Clasp.
- [Retrieve Carrier](https://docs.withclasp.com/api-reference/carriers/get-carriers-1.md): Retrieves info for a single carrier.
- [Employer Admin](https://docs.withclasp.com/api-reference/components/post-componentsemployer.md): 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.
- [Member Admin](https://docs.withclasp.com/api-reference/components/post-componentsmember.md): 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.
- [Delete Dependent](https://docs.withclasp.com/api-reference/dependents/delete-dependents.md): Permanently deletes a dependent.
- [List Dependents](https://docs.withclasp.com/api-reference/dependents/get-dependents.md): Lists all dependents under your provider.
- [Retrieve Dependent](https://docs.withclasp.com/api-reference/dependents/get-dependents-1.md): Retrieves a dependent's details.
- [Reveal SSN](https://docs.withclasp.com/api-reference/dependents/get-dependents-reveal_ssn.md): Reveals the unmasked SSN for the given dependent id.
- [Update Dependent](https://docs.withclasp.com/api-reference/dependents/patch-dependents.md): Updates a dependent's details.
- [Create Dependent](https://docs.withclasp.com/api-reference/dependents/post-dependents.md): Creates a dependent and associates it to a member.
- [Delete Employer Assignment](https://docs.withclasp.com/api-reference/employer_assignments/delete-employer_assignments.md)
- [List Employer Assignments](https://docs.withclasp.com/api-reference/employer_assignments/get-employer_assignments.md)
- [Retrieve Employer Assignment](https://docs.withclasp.com/api-reference/employer_assignments/get-employer_assignments-1.md)
- [Create Employer Assignment](https://docs.withclasp.com/api-reference/employer_assignments/post-employer_assignments.md)
- [Delete Employer Document](https://docs.withclasp.com/api-reference/employer_documents/delete-employer_documents.md): Permanently deletes the employer document.
- [List Employer Documents](https://docs.withclasp.com/api-reference/employer_documents/get-employer_documents.md): Retrieves the full list of every document uploaded.
- [Retrieve Employer Document](https://docs.withclasp.com/api-reference/employer_documents/get-employer_documents-1.md): Retrieves the employer document by id.
- [Update Employer Document](https://docs.withclasp.com/api-reference/employer_documents/patch-employer_documents.md): Updates the employer document. You must pass a URL of the uploaded document in the file field (e.g., S3).
- [Create Employer Document](https://docs.withclasp.com/api-reference/employer_documents/post-employer_documents.md): Adds a document and associates it to the specified employer.
- [List Employers](https://docs.withclasp.com/api-reference/employers/get-employers.md): Retrieves a list of all employers that are defined under your provider.
- [Retrieve Employer](https://docs.withclasp.com/api-reference/employers/get-employers-1.md): Retrieves a single employer object by employer id.
- [Update Employer](https://docs.withclasp.com/api-reference/employers/patch-employers.md): Updates an employer's details.
- [Create Employer](https://docs.withclasp.com/api-reference/employers/post-employers.md): Defines an employer in Clasp.
- [Delete Enrollment](https://docs.withclasp.com/api-reference/enrollments/delete-enrollments.md): 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.
- [List Enrollments](https://docs.withclasp.com/api-reference/enrollments/get-enrollments.md): Lists all enrollments under your provider.
- [Retrieve Enrollment](https://docs.withclasp.com/api-reference/enrollments/get-enrollments-1.md): Retrieves a single enrollment.
- [Approve Enrollment](https://docs.withclasp.com/api-reference/enrollments/post-enrollments-approve.md): Approves a submitted enrollment and sends it to the carrier.
- [Eligible Plans](https://docs.withclasp.com/api-reference/enrollments/post-enrollments-eligible_plans.md): Lists all eligible plans under an enrollment.
- [Reopen Enrollment](https://docs.withclasp.com/api-reference/enrollments/post-enrollments-reopen.md): Reopens a submitted enrollment to make changes.
- [Submit Enrollment](https://docs.withclasp.com/api-reference/enrollments/post-enrollments-save_and_submit.md): Stages an enrollment, but does not send to carrier. You are not able to edit submitted enrollments unless you reopen it.
- [List Groups](https://docs.withclasp.com/api-reference/groups/get-groups.md)
- [Retrieve Group](https://docs.withclasp.com/api-reference/groups/get-groups-1.md)
- [Update Group](https://docs.withclasp.com/api-reference/groups/patch-groups.md)
- [Create Group](https://docs.withclasp.com/api-reference/groups/post-groups.md)
- [Delete Member](https://docs.withclasp.com/api-reference/members/delete-members.md): Permanently deletes a member from Clasp. Do not use this if you are simply terminating employee. You must update their termination_date instead.  Only use this if you no longer want their record to exist (e.g., entry error).
- [List Members](https://docs.withclasp.com/api-reference/members/get-members.md): Lists all members under your provider.
- [Retrieve Member](https://docs.withclasp.com/api-reference/members/get-members-1.md): Retrieves details for a single member.
- [Reveal SSN](https://docs.withclasp.com/api-reference/members/get-members-reveal_ssn.md): Reveals the unmasked SSN for the given member id.
- [Update Member](https://docs.withclasp.com/api-reference/members/patch-members.md): Updates a member's details.
- [Create Member](https://docs.withclasp.com/api-reference/members/post-members.md): Defines a member in Clasp. Members are the primary policy holder (i.e., the employee receiving benefits).
- [Start Open Enrollment](https://docs.withclasp.com/api-reference/members/post-members-begin_open_enrollment.md): Triggers the start of a members open enrollment.
- [Create New Hire Enrollment](https://docs.withclasp.com/api-reference/members/post-members-new_hire_enrollment.md)
- [Create Qualifying Life Event](https://docs.withclasp.com/api-reference/members/post-members-qualifying_life_event.md): 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.
- [List Open Enrollment Windows](https://docs.withclasp.com/api-reference/open_enrollment_windows/get-open-enrollment-windows.md): Lists all open enrollment windows under your provider.
- [Retrieve Open Enrollment Window](https://docs.withclasp.com/api-reference/open_enrollment_windows/get-open-enrollment-windows-1.md): Retrieves details for a single open enrollment window.
- [Get Change Report](https://docs.withclasp.com/api-reference/open_enrollment_windows/get-open-enrollment-windows-change_report.md)
- [Get Completed Members](https://docs.withclasp.com/api-reference/open_enrollment_windows/get-open-enrollment-windows-completed_members.md)
- [Get Enrollment Census](https://docs.withclasp.com/api-reference/open_enrollment_windows/get-open-enrollment-windows-enrollment_census.md)
- [Get Incomplete Members](https://docs.withclasp.com/api-reference/open_enrollment_windows/get-open-enrollment-windows-incomplete_members.md)
- [Get Incomplete Members Report](https://docs.withclasp.com/api-reference/open_enrollment_windows/get-open-enrollment-windows-incomplete_members_report.md)
- [Update Open Enrollment Window](https://docs.withclasp.com/api-reference/open_enrollment_windows/patch-open-enrollment-windows.md)
- [Create Open Enrollment Window](https://docs.withclasp.com/api-reference/open_enrollment_windows/post-open-enrollment-windows.md)
- [Activate Open Enrollment Window](https://docs.withclasp.com/api-reference/open_enrollment_windows/post-open-enrollment-windows-activate.md): Activate an open enrollment window, changing its status to active.
- [Close Open Enrollment Window](https://docs.withclasp.com/api-reference/open_enrollment_windows/post-open-enrollment-windows-close.md)
- [Complete Open Enrollment Window](https://docs.withclasp.com/api-reference/open_enrollment_windows/post-open-enrollment-windows-complete.md)
- [Reopen Open Enrollment Window](https://docs.withclasp.com/api-reference/open_enrollment_windows/post-open-enrollment-windows-reopen.md)
- [Delete Pay Rate](https://docs.withclasp.com/api-reference/pay_rates/delete-pay_rates.md): Deletes a pay rate
- [List Pay Pay Rates](https://docs.withclasp.com/api-reference/pay_rates/get-pay_rates.md): List all pay rates that have been created
- [Retrieve Pay Rate](https://docs.withclasp.com/api-reference/pay_rates/get-pay_rates-1.md): Retrieves details for a single pay rate
- [Update Pay Rate](https://docs.withclasp.com/api-reference/pay_rates/patch-pay_rates.md): Update a pay rate. Note: effective_start dates may not be updated to cross existing pay rates.
- [Create Pay Rate](https://docs.withclasp.com/api-reference/pay_rates/post-pay_rates.md): 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
- [List Payroll Benefits](https://docs.withclasp.com/api-reference/payroll_benefits/get-payroll_benefits.md): Returns a list of all payroll benefit deductions.
- [Retrieve Payroll Benefit](https://docs.withclasp.com/api-reference/payroll_benefits/get-payroll_benefits-1.md): Retrieves a single payroll benefit deduction.
- [Update Payroll Benefit](https://docs.withclasp.com/api-reference/payroll_benefits/patch-payroll_benefits.md): Updates a single payroll benefit deduction. Commonly used to link benefits between Clasp and the payroll provider.
- [List Payroll Payments](https://docs.withclasp.com/api-reference/payroll_payments/get-payroll_payments.md): Returns a list of all payroll payments.
- [Retrieve Payroll Payment](https://docs.withclasp.com/api-reference/payroll_payments/get-payroll_payments-1.md)
- [Create Payroll Payment](https://docs.withclasp.com/api-reference/payroll_payments/post-payroll_payments.md): Creates a payroll payment to represent a paid paycheck for a given member to feed into ACA calculations.
- [Retrieve Plan Configuration](https://docs.withclasp.com/api-reference/plan_configurations/get-plan-configurations.md): Retrieves details for a single plan configuration.
- [Retrieve Contribution Strategy](https://docs.withclasp.com/api-reference/plan_configurations/get-plan-configurations-contribution_strategy.md): Retrieves the contribution strategy for a given plan.
- [List Plan Configurations](https://docs.withclasp.com/api-reference/plan_configurations/get-plan-configurations-list.md): Lists all plan configurations under your provider.
- [Create Plan Configuration](https://docs.withclasp.com/api-reference/plan_configurations/post-plan-configurations.md)
- [Define Contribution Strategy](https://docs.withclasp.com/api-reference/plan_configurations/post-plan-configurations-contribution_strategy.md): Defines a contribution strategy for a given plan.
- [Retrieve Premiums](https://docs.withclasp.com/api-reference/plans/get-plan-premiums.md): Retrieves the premiums for a given plan.
- [List Plans](https://docs.withclasp.com/api-reference/plans/get-plans.md): Lists all plans under your provider.
- [Retrieve Plan](https://docs.withclasp.com/api-reference/plans/get-plans-1.md): Retrieves details for a single plan.
- [Update Plan](https://docs.withclasp.com/api-reference/plans/patch-plans.md): Updates a plan's details.
- [Define Premiums](https://docs.withclasp.com/api-reference/plans/post-plan-premiums.md): Defines premiums for a given plan. A plan will have multiple premiums with different criteria. For example a simple 'composite' plan will have 5 premiums defining an 'amount' for each coverage type.
- [Create Plan](https://docs.withclasp.com/api-reference/plans/post-plans.md)
- [Calculate Age Banded Table](https://docs.withclasp.com/api-reference/premiums/post-age-banded-table.md): Calculates a sample age-banded table for a given 21-year-old rate. Many small group medical plans follow a similar age curve. Responds with a full list of premiums that can be passed to the /plans/{public_id}/premiums endpoint.
- [Enrollment Census](https://docs.withclasp.com/api-reference/reports/enrollment_census.md): Generates a report containing demographic and election information for employees and their dependents.
- [Member Census](https://docs.withclasp.com/api-reference/reports/member_census.md): Generates a report containing a full list of employee demographic information
- [Payroll Deductions](https://docs.withclasp.com/api-reference/reports/payroll_deductions.md): Generates a payroll deduction report for all of the group’s active plans.
- [Delete Subclass](https://docs.withclasp.com/api-reference/subclasses/delete-subclass.md): Permanently deletes the defined subclass.
- [List Subclasses](https://docs.withclasp.com/api-reference/subclasses/get-subclass.md): Lists all subclasses under your provider.
- [Retrieve Subclass](https://docs.withclasp.com/api-reference/subclasses/get-subclass-1.md): Retrieves the details of a single subclass.
- [Update Subclass](https://docs.withclasp.com/api-reference/subclasses/patch-subclass.md): Updates the subclass details.
- [Create Subclass](https://docs.withclasp.com/api-reference/subclasses/post-subclass.md): Defines the details of a subclass.
- [Delete Task](https://docs.withclasp.com/api-reference/tasks/delete-tasks.md): Permanently deletes a task.
- [List Tasks](https://docs.withclasp.com/api-reference/tasks/get-tasks.md): Lists all tasks for a given provider. Use the completed query parameter to filter between outstanding and completed tasks.
- [Retrieve Task](https://docs.withclasp.com/api-reference/tasks/get-tasks-1.md): Retrieves the details of a single task.
- [Update Task](https://docs.withclasp.com/api-reference/tasks/patch-tasks.md): Updates a task. Most commonly used to update the completed_at field when the task is complete.
- [Create Task](https://docs.withclasp.com/api-reference/tasks/post-tasks.md): Defines a task in Clasp. Tasks are usually created automatically based on events that occur (e.g., QLE, new hire, etc).
- [Authentication](https://docs.withclasp.com/guides/authentication.md)
- [Error Handling](https://docs.withclasp.com/guides/error_handling.md)
- [Component Page Navigation](https://docs.withclasp.com/guides/navigation.md): Learn to customize Clasp's navigation
- [Pagination](https://docs.withclasp.com/guides/pagination.md)
- [Rate Limiting](https://docs.withclasp.com/guides/rate_limiting.md)
- [Component Styling](https://docs.withclasp.com/guides/styling.md): Clasp gives you complete control over the look and feel of the components your embedding
- [Webhooks](https://docs.withclasp.com/guides/webhooks.md)
- [Overview](https://docs.withclasp.com/overview.md): Building an employee benefits product with Clasp
- [Quickstart Guide](https://docs.withclasp.com/quickstart.md): Clasp API basics.

## OpenAPI Specs

- [schema](https://docs.withclasp.com/schema.yaml)