Insurance Group Benefits Business APIs
Use the Group Benefits API resources to effectively manage the insurance plans offered
to groups, such as employees and their dependents.
Available in: Lightning Experience
Available in: Professional, Enterprise, and Unlimited Editions of Digital Insurance with Digital Insurance Product Admin Add On, Digital Insurance Group Benefits AddOn, Digital Insurance Group Enrollment AddOn,Digital Insurance Group Benefits Customer Community AddOn, and Digital Insurance Group Benefits Partner Community AddOn licenses
This table lists the available Insurance Group Benefits resources.
| Resource | Description |
|---|---|
| /connect/insurance/accounts (POST) | Create person accounts and portal users for group census members so that members can be linked to their policies and can log in to the community portal. |
| /connect/insurance/contacts (POST) | Create contacts and portal users for group census members so that members can be linked to their policies and can log in to the community portal. |
| /connect/insurance/group-census-members/memberId/action/rate (POST) | Calculate pricing and employee and employer contributions for an individual group census member based on the plan and coverages within the plan. |
| /connect/insurance/census-management/group-censuses/groupCensusId/group-census-members (POST, PATCH, DELETE) | Add (POST) and update (PATCH) group census members. Delete all census members for the specified group census ID. |
| /connect/insurance/census-management/group-censuses/groupCensusId/group-census-members/delete (POST) | Delete one or more census members of the specified group census ID. |
| /connect/insurance/census-management/group-censuses/groupCensusId/group-census-members/bulk-process (POST) | Add, update, or delete group census members in bulk using an asynchronous batch job. |
| /connect/insurance/census-management/group-censuses/groupCensusId/sync-summary (POST) | Synchronize and recalculate the summary data for a group census. |
| /connect/insurance/census-management/group-census-members/memberId/plans (POST, PATCH) | Create (POST) and update (PATCH) insurance plans for a group census member. |
| /connect/insurance/census-management/group-census-members/memberId/plans/action/delete (POST) | Delete the specified plans for a group census member. |
| /connect/insurance/census-management/group-census-members/memberId/eligible-plans (GET) | Get the contract group plans for which a group census member and their dependents are eligible. |
| /connect/insurance/census-management/group-census-members/memberId/enrollment-rules/actions/invoke (POST, PATCH) | Evaluate product configuration rules for a group census member based on the selected plan and coverage options during initial enrollment (POST). Reevaluate plan eligibility for a group census member when plans are added or removed (PATCH). |
| /connect/insurance/contracts (POST) | Create a group benefits contract from a quote. Supports asynchronous operation for long-running conversions. |
| /connect/insurance/quotes/quoteId/group-rating (POST) | Rate a group benefits quote to calculate premiums for all quote line items, or rate specific root plans to calculate premiums for their associated quote line items. |
| /connect/insurance/group-census-members/memberId/policies (POST) | Enroll a group census member in a group benefit insurance plan, creating the necessary policy records. |
| /connect/insurance/group-censuses/censusId/policies (POST) | Enroll all members of a group census in their selected group benefit insurance plans as a single asynchronous bulk operation. |