Responses

Learn more about the available response bodies of insurance group benefits APIs.

Bulk Group Census Management
Output representation for the bulk processing of employee census data.
Contract Endorsement Response
Output representation of the details when an endorsed contract version is created from a quote.
Contract Renewal Response
Output representation of the details when a renewed group benefits contract is created from a quote.
Delete Member Plans
Output representation for the member plan deletion process.
Family Policy Details
Output representation for individual group policy information.
Group Enrollment Response
Output representation for the Group Enrollment API. Returns the asynchronous request ID for the bulk enrollment job, along with any errors that occurred before the job was scheduled.
Group Rating Response
Output representation of the Group Benefits Group Rating process.
Insurance Person Accounts and Users Creation Response
Output representation of the person account and user creation process.
Insurance Member Account and User Details
Output representation of a member's person account and portal user details that are created.
Insurance Error
Output representation for an error that occurred during a census management operation.
Insurance Member Rating
Output representation of the rating for individual members.
Insurance Member Rating Details
Output representation of an individual member's rating results.
Insurance Plan Rating
Output representation of an individual plan's pricing result.
Insurance Coverage Rating
Output representation of an individual coverage's pricing result.
Insurance Contribution
Output representation of contribution information in an individual rating.
Insurance Object Map
Output representation for a map of attributes with string keys and object values.
Insurance Contacts and Users Creation Response
Output representation of the contact and user creation process.
Insurance Contract Transactions Generation Response
Output representation of the details when you start asynchronous generation of contract transactions for a group benefits contract.
Insurance Member Contact and User Details
Output representation of a member's contact and portal user details that's created.
Insurance Group Census Member Management
Output representation for the details of the group census members.
Insurance Census Summary Sync Details
Output representation of an employee census summary synchronization.
Insurance Group Census Details
Output representation of group census summary data.
Group Census Deep Clone Response
Output representation of the details that are returned after a group census deep-clone request is processed. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.
Group Census Field Mapping Response
Output representation of the details that are returned after a group census field-mapping request is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.
Members With Plans Response
Details returned after a family of group census members and their plans is added or updated. The response includes a success flag, top-level errors, and per-member results.
Member With Plans Details
Details for one group census member that was created or updated, including the member ID, associated plan IDs, and any member-level errors.
Member Overrides Response
Output representation of the details that are returned after member overrides are upserted or cloned on a root quote line item. The response includes a success parameter to indicate if the operation is successful and any errors that occurred during processing if the operation didn't succeed.
Insurance Group Endorsement Response
Output representation of the details that are returned after a request to apply mid-term contract adjustments to member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.
Insurance Group Adjustment Response
Output representation of the details that are returned after a bulk mid-term adjustment request is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.
Insurance Group Renewal Response
Output representation of the details that are returned after a request to renew member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.
Price Comparison Response
Output representation of the price impact that's calculated for a group census. The response includes the available product categories, the event summary, the rating periods, the currency, and a flat list of comparison items that carry the previous and current amounts for each plan, group class, member, and coverage.
Price Comparison Item Details
Output representation of the details of a single node in the price comparison, such as the overall summary, a plan, a group class, a member, or a coverage. The comparison is returned as a flat list of items. Build the hierarchy by matching the parent value of an item with the id value of another item.
Price Comparison Impact Details
Output representation of the priced amounts for one side of a comparison. Each comparison item returns this representation twice, once as the previous amounts and once as the current amounts, so that you can show the price impact of the change.
Price Comparison Attribute Details
Output representation of the details of a single plan or coverage attribute, such as copay or coinsurance, that's returned with a price comparison node. Attributes are returned only when the request sets fetchAttributes to true.
Price Comparison Currency Details
Output representation of the details of the currency that all amounts in a price comparison are expressed in. Use these details to format the previous and current amounts for display.
Price Comparison Duration Details
Output representation of the details of a rating period that the comparison amounts apply to. Match the key value with the durationKey value of a comparison item to find the period that the item's amounts cover.
Price Comparison Summary Details
Output representation of the counts of the membership events in the group census that contribute to the price change, such as hires, endorsements, and terminations. Use these counts to explain why the price moved between the previous and the current amounts.
Group Census Group Class Summary
Output representation of census summary data aggregated by group class.
Insurance Update Member Plans
Output representation for the update member plans operation.
Insurance Add Member Plans
Output representation for the add member plans operation.
Insurance Member Eligible Plans Response
Output representation for a member's eligible plans.
Members Plans
Output representation for a list of members with their eligible plans.
Insurance Member Plans
Output representation of the Insurance Get Member Plans service for an individual member.
Insurance Plan List
Output representation for a list of contract group plans.
Insurance Plan Details
Output representation for contract group plans.
Insurance Plans Eligibility Details
Output representation of the plan eligibility check for an.
Eligible Plan Details
Output representation for the details of the eligible plans.
Insurance Message Output
Output representation of an insurance message, which can be informational or an error.
Insurance Group Plans
Output representation of an insurance group plan.
Contract Creation Response
Output representation of the group benefits Quote-to-Contract process.
Insurance Create Quote From Contract Response
Response returned when creating a group benefits quote from an existing contract.
Insurance Generate Census Response
Output representation of the details when you generate a group census from the policies on an existing group benefits contract.
Update Group Census Response
Output representation of the details that are returned when you update a group census from policy enrollments and endorsements on an existing group benefits contract.
Insurance Generate Refresh Census Members Response
Output representation of the details when you generate or update group census members from policy information on an existing group benefits contract.
Issue Contract Response
Output representation of the details when a group benefits contract is issued synchronously from a quote.
Individual Enrollment Response
Output representation for the Individual Enrollment API.

Insurance Developer Guide

Responses