Resources

Learn more about the available insurance group benefits API resources.

Create Quote From Insurance Contract (POST)
Create an endorsement or renewal quote from an existing group benefits contract, including the quote structure and line items, without re-entering contract details manually.
Deep Clone Group Census (POST)
Clone a group census and its hierarchy, including members, member plans, and plan attributes. Use this API to copy one census data into another, apply field-level overrides, and optionally filter or remap member plan references. This API clones all reference data linked to the group census ID and supports field-level transformations to add to new values on existing data. You can apply filters to select the specific records to clone, such as filtering group census member plans by quote ID, and can use custom context definitions to include unique fields and specialized mappings.
Endorse Contract (POST)
Create an endorsed contract version from a quote for mid-term adjustments. This API carries forward the existing contract and contract group plan details, and links the new version to the previous contract. It also creates contract and contract group plan records along with their associated attributes.
Map Group Census Fields (POST)
Map fields on an existing group census to the corresponding quote or contract records without creating new records. Use this resource to remap references from quote records to contract records, or from contract records back to quote records, for example after a quote is converted to a contract. This API runs asynchronously and returns a request ID that you can use to track the job status.
Member Overrides (POST, DELETE)
Apply, clone, or revert member-level plan and attribute overrides on a root quote line item. Use POST to upsert overrides or to clone them from a source member to one or more target members. Use DELETE to revert overrides for a member.
Group Renewal (POST)
Renew insurance policies of group census members for a contract renewal. This API creates insurance policies under the renewed contract for each primary census member in the specified group census, links the new policies to their previous policies, and records renewal transactions. The API runs asynchronously and returns a request ID that you can use to track the job status.
Group Census Price Comparisons (POST)
Compare the previous and the current prices for a group census so that you can show the price impact of an enrollment or a mid-term adjustment before it's finalized. Scope the comparison to a product category or to specific members, and optionally return the plan and coverage attributes along with the amounts.
Group Census Members With Plans (POST, PATCH)
Add or update a family of group census members and their insurance plans in a group census. Use POST to add members and plans, and PATCH to update an existing family and the plans associated with those members.
Generate Insurance Contract Transactions (POST)
Generate contract-level transaction details for a group benefits contract over a specified date range. The API groups existing policy transactions into InsuranceContractTrxn (header) and InsuranceContractTrxnDetail (line item) records. This API runs asynchronously and returns a job ID to track the job status.
Generate Group Census From Insurance Contract (POST)
Generate a group census from the policies on an existing group benefits contract, optionally filtering by contract group plans, contacts, or person accounts. This API runs asynchronously and returns a request ID that you can use to track the job or retry a failed run.
Update Group Census (PATCH)
Update a group census from policy enrollments and endorsements on an existing group benefits contract for a specified date range. This API runs asynchronously and returns a request ID that you can use to track the job or retry a failed run.
Generate or Update Group Census Members (POST)
Generate or update group census members and their plan configuration details from policy information on an existing group benefits contract for one or more person accounts or contacts.
Group Enrollment (POST)
Enroll all members of a group census in their selected group benefit insurance plans as a single asynchronous bulk operation. The API response returns the ID of the bulk request so that you can track the enrollment job.
Individual Enrollment (POST)
Enroll a group census member in a group benefit insurance plan, creating the necessary policy records.
Insurance Person Accounts and Users (POST)
Create person accounts and portal users for group census members. The Person Account is used for linking to the appropriate policy for policy association, and the corresponding portal user is created to allow the member to log in to the community portal.
Insurance Contacts and Users (POST)
Create contacts and portal users for group census members. The Contact record is used for linking to the appropriate policy for policy association, and the corresponding portal user is created to allow the member to log in to the community portal.
Insurance Member Rating (POST)
Calculate pricing along with employee and employer contribution for individual members of a group census based on plan and coverages within the plan.
Insurance Bulk Census Management (POST)
Process group census data in bulk.
Insurance Group Census Members (POST, PATCH, DELETE)
Add (POST) and update (PATCH) group census members. Delete all census members for the specified group census ID.
Insurance Group Census Members Delete (POST)
Delete one or more census members of the specified group census ID.
Insurance Group Rating (POST)
Rate a group benefits quote to calculate premiums for all quote line items. Rate specific root plans to calculate premiums for their associated quote line items.
Insurance Census Summary Sync (POST)
Synchronize and recalculate the summary data for a group census.
Insurance Member Plans (POST, PATCH)
Create and update insurance plans for a group census member.
Insurance Member Plans Delete (POST)
Delete specified plans for a group census member.
Insurance Member Eligible Plans (GET)
Get the contract group plans for which a group census member and their dependents are eligible.
Insurance Plans Eligibility Check (POST, PATCH)
Evaluate product configuration rules for a group census member based on their selected plan and coverage options during initial enrollment (POST). Reevaluate plan eligibility for a group census member when plans are added or removed (PATCH).
Issue Contract From Quote Asynchronous (POST)
Create a group benefits contract from a quote. This API supports asynchronous operation for long-running conversions.
Issue Contract From Quote (POST)
Issue a group benefits contract from a quote synchronously to activate coverage.
Member Policies Adjustment (POST)
Apply mid-term contract adjustments to the eligible member policies in a group census. Use this resource after an endorsed contract version is created so that member policies reflect the contract changes. This API runs asynchronously and returns a request ID that you can use to track the job status.
Member Plans Adjustment (POST)
Apply contract mid-term adjustments to update member plans in bulk. You can either reuse existing premiums or recalculate them using the rating engine. This API runs asynchronously and returns an ID to track the job.
Renew Contract (POST)
Create a renewed insurance contract from a renewal quote, carrying forward the applicable contract details and line items for the next coverage term.

Insurance Developer Guide

Resources

See Also