Add Eligible Insurance Clauses Action: Add eligible insurance clauses to a quote or context. You must specify either a quote ID or a context ID, and either an instance key or a quote line item ID along with insurance product clause details.
Apply Member Overrides Action: Apply member-specific overrides that differ from the member’s group class default configuration on a group insurance quote. Use this action to apply plan, coverage, or attribute overrides, or to clone an override configuration from one group census member to one or more target group census members on the same root plan. Cloning replaces each target member’s existing override configuration.
Calculate Adjustments Action: Calculate the adjusted amount for a loss item and generate data for insurance policy limit tracking and claim coverage payment adjustment records.
Cancel Insurance Brokerage Policy Action: Cancel an insurance brokerage policy with optional cancellation details such as effective date, reason, and target status.
Census Management: Create, update, clone, and map group census members and their plans.
Check Financial Authority Action: Check whether the currently authenticated user has sufficient financial authority to approve a claim coverage payment detail record.
Compute Producer Splits Action: Compute the producer splits for the producers associated with an Insurance Policy, for a Commission Statement Line Item.
Create Producer Commissions Action: Create records for the commissions that producers receive for the insurance policy associated with the specified commission statement line item, and update the commission statement line item record status.
Create Insurance Quote Action: Create an Insurance quote by using a context ID or a set of user inputs that represent quote details.
Endorse Multi-Root Insurance Policy Action: Create an endorsement for an existing multi-root insurance policy to apply updates or changes to the policy and its associated child policies.
Financial Management: Rate quotes and members, compare census prices, and generate contract transactions.
Find Insurance Policy Action: Get the insurance policy associated with a commission statement line item that matches the specified criteria, and update the status of the commission statement line item record.
Generate Insurance Clauses Action: Generate insurance clauses based on the specified quote and context information. You must specify either quote ID or context ID to generate insurance clauses.
Generate Insurance Contract Transaction Action: Asynchronously generate insurance contract transactions (InsuranceContractTrxn and InsuranceContractTrxnDtl records) for the specified contract ID over a given date range.
Generate or Update Group Census Members Action: Generate or update group census members and their plan configuration details based on policy information from an insurance contract for one or more person accounts or contacts.
Get Applicable Auto-Assigned Member Plans Action: Get a combined collection of group census member plans, including the specified plans and plans that are automatically assigned based on contract settings.
Get Census Price Comparison Action: Calculate price comparison impacts for group census members based on their plan enrollments. This action calculates the financial comparison of changes to a group census by comparing the previous and current costs across plans, group classes, members, and coverages, returning a breakdown of total cost, premium, tax, and fees to help evaluate the comparison of proposed changes.
Get Eligible Insurance Clauses Action: Get eligible insurance clauses based on quote ID and context ID. You must specify either a quote ID or a context ID, and either an instance key or a quote line item ID to get the eligible insurance clauses.
Get Group Census Members Action: Get the group census member records from the content document in the specified asynchronous bulk request item record.
Get Group Census Members and Plans Action: Get the group census member records and associated plans from the content document in the specified asynchronous bulk request item record.
Get Insurance Rating Input Action: Get the rating input data for the insurance products to support the pricing calculations and coverage analysis.
Get Member Ratings and Contributions Action: Get standard and prorated insurance rates for the specified group census members and their selected plan coverages, including contributions.
Create Contract From Quote Synchronous Action: Issue a group insurance contract from a quote, creating both the contract and insurance contract records with the full contract group plan hierarchy, including their plan attributes and group class attributes.
Pay Claim Coverage Payment Detail Action: Initiate the payment for a claim coverage payment detail record, track the policy limit consumption for the payout, and update the status of the claim coverage payment detail record to Paid.
Pay Ex Gratia Claim Coverage Payment Detail Action: Process ex gratia payments for the claim coverage payment detail record when the adjusted amount is greater than the policy limit amount or count or both.
Preview Policy Premium Action: Preview prorated and rolled-up premium amounts across the insurance policy hierarchy without creating or updating the changes.
Apply Contract Adjustment to Member Policy Action: Apply contract adjustment to group insurance policy for a primary group census member and a contract group plan. For each plan, the action enrolls a new policy, endorses an existing policy, or cancels a policy for a removed plan based on the endorsed contract version and the member's plan configuration.
Renew Group Census Member Policies Action: Renew group census member policies for contract renewal. This action creates renewed insurance policies, and links the newly created policies to the previous policies.
Quote Management: Create quotes from existing contracts and apply member-level plan overrides.
Recalculate Adjustments Action: Recalculate the adjusted amount for a claim loss item to the maximum amount that’s allowed by the insurance policy.
Update Group Census Action: Asynchronously update a group census using the insurance contract data. Specify the date range, and the API updates the group census member and plan configuration details based on the policy enrollments or adjustments during the specified time period.
Renew Contract Action: Renew a group insurance contract by creating a new contract for the next term from a renewal quote, carrying forward the relevant contract details and line items.
Revert Member Overrides Action: Revert all overrides for a member under a root quote line item and restore the member details to the default configuration of the group class.
Save Group Census Members Data Action: Create or update the group census member records for primary members, update the IDs of the dependent members, and create or update groups census member records for the dependent members.
Verify Policy Coverage Action: Verify whether a policy coverage is applicable for a specified loss date under an insurance policy, so that only eligible coverages are processed for claims.
getRatingInput(insGetRatingInputInputRepresentation): Generate a sample rating input for the specified insurance product, and use the generated rating input as the request body in the Insurance Product Rating API after replacing sample values with real data.
lookupErrorCode(insLookupErrorCodeInputRepresentation): Look up an insurance error code to retrieve its human-readable description, root cause, and step-by-step resolution instructions when a product model validation error is encountered during setup.
InsuranceDesignAdvisorFamily Class: Use the Insurance Design Advisor Apex methods at design time to validate product model setup, attributes, pricing configuration, API request payloads, user permissions, and related insurance configuration before runtime. To use these methods, the org must have Insurance Design Advisor enabled.
validateApiRequest(insRequestValidationInputRepresentation): Validate a JSON request body for the Insurance Quote or Insurance Product Rating API by checking product codes, attributes, instance keys, and required fields against the configured product model.
validateAttributes(insAttributeValidationInputRepresentation): Validate that the specified attribute definitions exist in the org and are active. This method returns a per-attribute validation status with resolution guidance for any attribute that can't be validated.
validateCMLModel(insCMLModelValidationInputRepresentation): Validate the active CML (Constraint Markup Language) model for the specified insurance products and related records. Returns validation status for each specified record along with resolution guidance when the CML configuration is incomplete or inconsistent.
validateProductModel(insProductModelValidationInputRepresentation): Validate the setup and configuration of insurance product models at design time. Provide a root product ID to check the entire product hierarchy for configuration errors that could cause failures during quoting, rating, or policy issuance.
validateUserPermissions(insValidateUserPermissionsInputRepresentation): Validate whether a user has the necessary org-level and user-level permissions to perform an insurance operation, such as creating a quote or policy, and return troubleshooting guidance when the user isn’t authorized.
deepCloneGroupCensus(groupCensusDeepCloneInputRepresentation,
censusId): Clone a group census and its hierarchy, including members, member plans, and plan attributes. Use this method to copy quoting-phase census data into an enrollment-type census, apply field-level overrides, and optionally filter or remap member plan references.
mapCensusFields(censusId,
groupCensusFieldMappingInputRepresentation): Map fields on an existing group census to the corresponding quote or contract records without creating new records. Use this method 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.
postInsuranceGroupRenewal(censusId,
insuranceGroupRenewalInputRepresentation): Renew insurance policies of group census members for a contract renewal. Use this method to create insurance policies under the renewed contract for each primary census member, link the new policies to their previous policies, and record renewal transactions.
InsuranceGroupBenefitsFamily Class: Effectively manage the insurance plans that are offered to groups, such as employees and their dependents, by using the Group Benefits feature on the Digital Insurance platform. Simplify the Group Benefits workflow through a unified platform for all processes, including census management, quote configuration and pricing, contract creation, and enrollment.
CancelPolicy(CancelPolicyInput, policyId): Cancel an insurance policy version. The API takes the effective date of cancellation from the input JSON. You can advance the cancellation date within the policy term, but you can’t postpone the cancellation.
EndorsePolicy(EndorsePolicyInput, policyId): Endorse the latest version of the insurance policy based on the context ID and effective date. You can also include other optional fields and additional details in the input JSON.
MultiRootRenewPolicy(RenewPolicyInput, policyId): Asynchronouly renew a multi-root insurance policy, create renewed records for the parent policy and the associated child policies. Use the priced context ID for the renewal process.
RenewPolicy(RenewPolicyInput, policyId): Use the context ID of an existing policy to renew a policy. Modify the renewal date, and add optional fields and additional information in the input JSON.
InsurancePolicyAdminFamily Class: Manage insurance policies comprehensively, for different transaction types, such as issuance, endorsement, renewal, and cancellation.
AddEligibleInsuranceClausesOptions Class: Contains options for adding eligible product clauses to an insurance product. Use this class when configuring which clauses, such as exclusions or coverage terms, are available for selection on an insurance product.Learn more about the constructors that are available with the AddEligibleInsuranceClausesOptions class.Creates an options instance with the specified context-saving behavior for adding eligible insurance clauses.Creates an options instance with default settings for adding eligible insurance clauses. Context is not saved by default.Set the AddEligibleInsuranceClausesOptions class property to save the context of a quote.Indicates whether to save the operation context when adding eligible insurance clauses (true) or not (false).
CreateInsuranceQuoteOptions Class: Contains options for creating an insurance quote. Use this class to control pricing execution, product catalog validation, configuration and qualification rules, quote persistence, and the product selling model when creating group or individual insurance quotes.Learn more about the constructors that are available with the CreateInsuranceQuoteOptions class.Creates an options instance for quote creation with explicit control over pricing, validation, rules execution, quote saving, and product selling model.Creates an options instance with the default settings for creating an insurance quote.Set the CreateInsuranceQuoteOptions class properties to create an insurance quote.Indicates whether product configuration rules are executed when creating the insurance quote (true) or not (false).Indicates whether pricing is executed when creating the insurance quote (true) or not (false).Indicates whether qualification rules are executed when creating the insurance quote (true) or not (false).Identifies the product selling model that's used for the insurance quote, for example, group or individual.Indicates whether the created quote is saved in the database (true) or not (false).Indicates whether the product catalog is validated when creating the insurance quote (true) or not (false).
CreateInsuranceRatingOptions Class: Contains options for creating an insurance rating. Use this class to control pricing execution, configuration rules, and the response data, such as context JSON, product details, rating results, when running a rating operation.Learn more about the constructors that are available with the CreateInsuranceRatingOptions class.Creates an options instance for rating with explicit control over pricing, configuration rules, and which data is returned in the response.Creates an options instance with the default settings for creating an insurance rating.Set the properties in the CreateInsuranceRatingOptions class to create insurance ratings.Indicates whether to run product configuration rules (true) or not (false).Indicates whether to execute pricing for the rating (true) or not (false).Indicates whether to include context as JSON in the response (true) or not (false).Indicates whether to include product details in the response (true) or not (false).Indicates whether to include rating results in the response (true) or not (false).
GenerateInsuranceClausesOptions Class: Contains options for generating insurance clauses. Use this class to control context saving, manual clause generation, and asynchronous clause generation when generating product clauses for insurance products.Learn more about the constructors that are available with the GenerateInsuranceClausesOptions class.Creates an options instance with full control over context saving, manual clause generation, and asynchronous execution.Creates an options instance for synchronously generating insurance clauses with context and manual clause settings.Creates an options instance with the default settings for generating insurance clauses.Set the properties in the GenerateInsuranceClausesOptions class to generate insurance product clauses.Indicates whether clauses are generated asynchronously (true) or synchronously (false).Indicates whether to generate manual clauses along with system-generated clauses (true) or not (false).Indicates whether to save the operation context (true) or not (false).
UpdateInsuranceQuoteOptions Class: Contains options for updating an existing insurance quote. Use this class to control pricing execution, configuration and qualification rules, product catalog validation, and quote persistence when updating insurance quotes.Learn more about the constructors that are available with the UpdateInsuranceQuoteOptions class.Creates an options instance for quote updates with explicit control over pricing, configuration and qualification rules, catalog validation, and quote saving.Creates an options instance with the default settings for updating an insurance quote.Set the properties in the UpdateInsuranceQuoteOptions class to update an insurance quote.Indicates whether to run product configuration rules when updating the quote (true) or not (false).Indicates whether to execute pricing when updating the quote (true) or not (false).Indicates whether to run qualification rules when updating the quote (true) or not (false).Indicates whether to save the updated quote (true) or not (false).Indicates whether to validate against the product catalog when updating the quote (true) or not (false).
ConnectApi.CreatePolicyLimitsInputRep: Input representation for the apex ConnectApi.CreatePolicyLimitsInputRep record that contains the details of the policy limits to be created.
ConnectApi.EndorsePolicyInputRepresentation: Input representation of the request to endorse a policy. Context ID of the quote that’s used for endorsement and date that the endorsed policy version is effective from must be passed in the request.
ConnectApi.GetInsPlcyCurrStndInputRep: An Apex ConnectApi.GetInsPlcyLmtCurrStndInputRep record that contains the details needed to retrieve the consumed and available limits for the policy or claim.
ConnectApi.GroupCensusDeepCloneInputRepresentation: Input representation of the details to clone a group census hierarchy, including optional filters, reference mappings, field overrides, and a custom context definition.
ConnectApi.InsAttributeInputRepresentation: Input representation of one attribute definition to validate. Provide at least one of attribute ID, attribute code, or developer name.
ConnectApi.InsuranceContractEndorseInputRepresentation: Input representation of the quote ID, endorsement effective date, optional date-copy behavior, and additional fields used to create an endorsed contract version from a quote.
ConnectApi.InsuranceContractItem: Input representation of an entity, product path, and field values used to extend a contract when you issue it from a quote.
ConnectApi.InsuranceContractRenewalInputRepresentation: Input representation of the quote ID, renewal date, optional contract end date and term, and additional fields used to create a renewed-term contract from a quote.
ConnectApi.InsuranceGenerateCensusInputRepresentation: Input representation of the census name and type, optional policy date, filters, and generation options used to create a group census from the policies on a contract.
ConnectApi.InsuranceGenerateRefreshCensusMembersInputRep: Input representation of the census details, member identifiers, optional policy date, and additional fields used to generate or update group census members from policy information on a contract.
ConnectApi.InsuranceIssueContractInputRepresentation: Input representation of the quote ID, optional contract dates and term, transaction detail level, and additional fields used to issue a group benefits contract from a quote.
ConnectApi.InsurancePolicyBulkRenewInputRepresentation: Input representation details of the renew insurance policies in bulk resource. The input includes the list of insurance policy IDs to be renewed and the details of the associated fields of the insurance policies.
ConnectApi.InsurancePolicyDraftInputRepresentation: Input representation for the endorsement draft request. Includes a field value map that specifies the insurance policy fields to override in the draft.
ConnectApi.InsuranceQuoteItem: Input representation for an insurance quote item that identifies an entity, product path, and additional field overrides.
ConnectApi.InsuranceRefreshCensusInputRepresentation: Input representation of the group census ID, date range, optional filters, and update options used to refresh a group census from policy enrollments and endorsements on a contract.
ConnectApi.InsuranceUpsertMemberRep: Input representation of a group census member and the additional field values to apply during an upsert operation.
ConnectApi.PremiumPreviewInputRep: Input representation for a draft-state premium preview. Specify hierarchy-node references to compute, or leave the list empty to return only the policy-root amounts.
ConnectApi.PremiumPreviewReferenceRep: Input representation of a reference to a node in the insurance policy hierarchy whose rolled-up premium amounts you want to preview.
ConnectApi.CheckFinancialAuthorityRep: Contains the result of a financial authority check for a claim coverage payment detail, including whether payment is allowed and the user’s maximum approval amount.
ConnectApi.GetInsPlcyCurrStndOutputRep: An Apex ConnectApi.GetInsPlcyCurrStndOutputRep record that contains the details of the consumed and available limits that are retrieved for the policy or claim.
ConnectApi.GroupCensusDeepCloneRepresentation: Output representation that's 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.
ConnectApi.GroupCensusFieldMappingRepresentation: Output representation that's 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.
ConnectApi.InsAttributeValidationRepresentation: Output representation of the per-attribute validation results. Each result reports whether the attribute definition exists and is active, and includes resolution guidance when it isn't.
ConnectApi.InsAttributeValidationResultRepresentation: Output representation of the validation result for one attribute lookup. The result includes the identifiers from the request and includes resolution guidance when the attribute definition can't be validated.
ConnectApi.InsCMLModelValidationResultRepresentation: Output representation of the validation result for a single record. When the record isn’t valid, instructions describes the failure and recommended correction.
ConnectApi.InsGetRatingInputRepresentation: Output representation that contains the generated sample rating input payload as a JSON string, or errors if generation fails.
ConnectApi.InsLookupErrorCodeRepresentation: Output representation that contains the looked-up error code description, optional cause, resolution instructions, and any request-level errors.
ConnectApi.InsProductDiscoveryValidationRepresentation: Output representation of the product discovery validation result, including whether the product’s discovery setup is valid and any related errors or informational messages.
ConnectApi.InsProductHierarchyValidationRepresentation: Output representation of the validation result for a single product in the root product hierarchy. The response includes products that failed at least one design-time check.
ConnectApi.InsRequestValidationRepresentation: Output representation that contains the overall request validation result, individual findings, and any request-level errors that prevented validation.
ConnectApi.InsValidateUserPermissionsRepresentation: Output representation that indicates whether the user has the required permissions for the requested insurance operation, and remediation guidance when they don’t.
ConnectApi.InsuranceGroupEndorsementRepresentation: Output representation that's 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.
ConnectApi.InsuranceGroupRenewalRepresentation: Output representation that's 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.
ConnectApi.InsurancePolicyCancellationRepresentation: Output representation for the cancel policy response. Contains the transaction ID, a list of impacted policy versions, and any errors that occurred during the cancellation process.
ConnectApi.InsurancePolicyReinstatementRepresentation: Output representation for the reinstate policy response. Contains the reinstated policy ID, the transaction ID, and any errors that occurred during the reinstatement process.
ConnectApi.InsuranceRefreshCensusRepresentation: Output representation that's returned when you start updating a group census from policy enrollments and endorsements on a group benefits contract.
ConnectApi.MemberWithPlansRepresentation: Output representation for an individual group census member and the insurance plans that are added or updated for that member.
ConnectApi.PremiumPreviewRepresentation: Output representation of a draft-state premium preview, including the policy ID and per-node rolled-up amount results.
runtime_industries_insurance Namespace: The runtime_industries_insurance namespace provides Options classes to control optional input parameters for managing insurance operations, such as creating and updating insurance quotes, generating insurance clauses, and running insurance ratings. Use these classes when calling Insurance APIs from Apex to control pricing, configuration rules, qualification rules, and product catalog validation.
Cancel Policy: The policy cancellation process addresses the termination of an insurance policy before its scheduled expiration date. Common reasons for canceling a policy include not paying the premiums or a direct cancellation request from the policyholder.
Claims Processing Journey: A claim is a formal request submitted by a policyholder to receive benefits or compensation for a covered loss under an active insurance policy. A claim journey begins when the policyholder reports an incident, such as damage, injury, or another qualifying event that they believe is covered by their policy.
Additional Fields Field Set Input: Input representation for the list of the field set IDs for asset, coverage, participant, and policy objects.
Additional Fields Map Value: Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap.
Attribute Input: Input representation of an overridden attribute value on a group census member plan.
Group Census Deep Clone Input: Input representation of the details to clone a group census hierarchy, including optional filters, reference mappings, field overrides, and a custom context definition.
Group Census Field Mapping Input: Input representation of the filters and reference mapping rules used to remap fields on an existing group census in place, without creating new records.
Group Census Filters Input: Input representation of the per-entity filters that scope which group census member plan records are processed.
Insurance Attribute Input: Input representation of one attribute definition to validate. Specify at least one of attribute ID, attribute code, or developer name.
Insurance Attribute Validation Input: Input representation of the attribute definitions to validate. Each lookup identifies one attribute definition by ID, code, or developer name.
Insurance CML Model Validation Input: Input representation of the insurance products and related records to validate against the active CML model.
Insurance Quote Configuration Options Input: Input representation of the details to specify whether configuration and qualification rules run when creating a quote from a contract.
Insurance Get Rating Input Input: Input representation that specifies the product for which to generate a sample rating input payload.
Insurance Request Validation Input: Input representation that specifies the insurance Connect API path and serialized JSON request body to validate against the product model.
Insurance Add Member Plans Input: Input representation for adding plans to a census member. Use contractGroupPlanId to add standard plans defined in the group's contract, with the option to include attributes for granular overrides. Alternatively, use productCode and contractGroupPlanId to add off-contract coverages. When adding off-contract coverages, you can use the attributes parameter to define specific coverage details. productCode and contractGroupPlanId are mutually exclusive. You must provide one or the other based on whether the coverage is standard or off-contract.
Apex String: Input representation for a key-value pair.
Insurance Census Filter Input: Input representation of the filter criteria that select which policy records to include when generating a group census from a contract.
Insurance Contract Endorse Input: Input representation of the details, such as quote ID, endorsement effective date, optional enrollment window, and additional fields to create an endorsed contract version from a quote.
Insurance Contract Item Input: Input representation of the details, such as object, product path, and field values to extend a contract when issuing it from a quote.
Insurance Contract Renewal Input: Input representation of the details, such as the quote ID, renewal and contract end dates, and optional enrollment window, term, target contract, and additional fields to create a renewed-term contract from a quote.
Product Clause Input: Input representation for the details of a single product clause to be created.
Delete Member Plans Input: Input representation for deleting the insurance plans for a census member.
Insurance Generate Census Input: Input representation of the details to generate a group census from the policies on an existing group benefits contract.
Insurance Generate Refresh Census Members Input: Input representation of the details to generate or update group census members from policy information on an existing group benefits contract.
Insurance Group Adjustment Input: Input representation of the optional flow and repricing settings used to submit a bulk mid-term adjustment request for a group census. The source group census is supplied as the censusId path parameter.
Insurance Group Endorsement Input: Input representation of the optional flow and repricing settings that are used to apply mid-term contract adjustments to member policies in a group census.
Group Enrollment Input: Input representation for the Group Enrollment API. Use these properties to label the asynchronous bulk enrollment job and, optionally, to specify a custom flow to run for each member of the census.
Insurance Issue Contract Input: Input representation of the details, such as the quote ID, contract dates, enrollment window, and optional term and additional fields to use to synchronously issue a group benefits contract from a quote.
Insurance Policy Bulk Input: Input representation for bulk policy operations. Specify the list of insurance policy IDs and field value map of insurance policy fields for bulk operations.
Insurance Policy Cancellation Input: Send the cancellation details to cancel an insurance policy, including the effective date, reason, and target status.
Insurance Policy Draft Input: Send the field value map of insurance policy fields to create a draft endorsement for the specified policy.
Insurance Policy Reinstatement Input: Send the reinstatement details to reinstate a canceled insurance policy, including the reinstatement date and any policy field overrides.
Insurance Price Comparison Input: Input representation of the optional filters that scope a price comparison for a group census. Use these settings to narrow the comparison to a product category or to specific members, and to control whether to get the plan and coverage attributes in the response.
Update Group Census Input: Input representation of the details to update a group census from policy enrollments and endorsements on an existing group benefits contract.
Member Override Input: Input representation of a single member override, including the member, product or quote line item, operation, and any overridden attributes.
Member Overrides Input: Input representation of the member overrides to upsert or clone on a root quote line item, including an optional context ID and target member IDs for clone operations.
Member Plan Filter Input: Input representation of the filter that identifies which group census member plan records to process.
Member Plan Input: Input representation of an insurance plan to add or update for a group census member.
Member Plan Reference Mapping Input: Input representation of the reference mapping applied to group census member plan records, such as mapping a quote line item to a contract group plan or the reverse.
Member With Plans Input: Input representation of a group census member and the insurance plans to add or update for that member.
Members With Plans Input: Input representation of a family of group census members and their plans to add or update, including optional duplicate-detection fields, a processing flow, and configuration-rule settings.
Premium Preview Input: Input representation of the policy-hierarchy nodes to include in a draft-state premium preview. Omit or leave empty to return only the policy-level (root) rolled-up amounts.
Premium Preview Reference Input: Input representation of a node within the insurance policy hierarchy whose rolled-up premium amounts you want to compute.
Networks Input: Represents Insurance Policy Coverage Networks for creating plan benefits.
Update Plan Benefit Input: Update Insurance Policy Coverage Networks and Insurance Policy Coverage Benefits by using the ID of an Insurance Policy Coverage.
Verify Policy Coverage Input: Input representation of a policy coverage's applicability for a specified loss date under an insurance policy.
Bulk Endorse Draft Policy (POST): Create endorsement drafts in bulk for the specified insurance policies. You can modify the drafts until you endorse the policies using the Bulk Endorse Policy API. After you endorse the policies, you can't make any further changes.
Preview Policy Premium (POST): Preview prorated and rolled-up premium amounts for draft insurance policy hierarchy without creating or updating the changes.
Bulk Pay Claim Coverage Payment Details (POST): Initiate asynchronous payment processing for claim coverage payment detail records in bulk. Specify the claim coverage payment detail IDs you want to process for payment, and the API validates access, enqueues work, and returns an identifier you can use to track the bulk job.
Insurance Policy Limit Current Standings (POST): Get the calculated current standings (consumption status) for all applicable insurance policy limits. This API retrieves standings based on the policy, claim, claim coverage as well as policy coverage, insurance policy participant, and insurance policy asset.
Cancel Insurance Policy (POST): Cancel an insurance policy version. You can advance the cancellation date within the policy term, but you can’t postpone the cancellation.
Census Management: Create, update, clone, and map group census members and their plans.
Check Financial Authority (POST): Check whether the current user has sufficient financial authority to approve a claim coverage payment detail. The API matches a User Financial Authority (UFA) record to the payment detail’s product and financial type, compares the adjusted amount to the user’s maximum approval amount, and sets the payment detail status to Pending Authority when the limit is exceeded and a manager is available.
Claim (GET, PATCH): Get or update a claim record and its associated claim items and participants.
Commission Processing (POST): Process commission statements in an asynchronous manner using a preconfigured batch job.
Cost Calculation (PATCH): Calculate the premium, fee, or premium-equivalent amount at InsuranceRatePlanLineItem based on the underlying rate plan. The InsuranceRatePlanLineItem premium, fees, or premium equivalent amount is rolled up to the Insurance Rate Plan, Insurance Coverage, and Insurance Policy Premium Amount.
Claim Coverage Payment Detail (POST): Create a claim coverage payment detail record. This also generates the related records for the Insurance Policy Limit Tracking and Claim Coverage Payment Adjustment records if applicable.
Delete Claim Coverage Payment Detail (POST): Remove unpaid claim coverage payment details by updating the status to Deleted. The API reverses the insurance policy limit tracking data to roll back consumption for the type Loss.
Endorse Contract (POST): Create an endorsed contract version from a quote for mid-term adjustments. This API shortens the existing contract, creates a new version of the contract and contract group plan records along with their associated attributes based on the finalized endorsement quote, and links both versions.
Endorse Insurance Policy (POST): Endorse the latest version of the insurance policy based on the context ID and effective date. You can also include other optional fields and additional details in the request body.
Expected Revenue (PATCH): Calculate the expected revenue, derived both from an Insurance Rate Plan Commission object, such as a flat fee and percentage premium, and the premium, fee, or premium equivalent amount on Insurance Rate Plan. The expected revenue amount is rolled up from Insurance Rate Plan to Insurance Coverage and Insurance Policy expected revenue amount.
Field Set Fields (GET): Get the fields of a field set by the field set ID and object name.
Financial Management: Rate quotes and members, compare census prices, and generate contract transactions.
Generate Census Information from Policies for Contract (POST): Generate a group census along with member and optional plan configuration from the active policies on an existing group benefits contract. You can optionally filter based on 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.
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.
Policy Limits (POST): Create insurance policy limit records for the specified policy based on its defined product attributes and coverages.
Insurance Policy Details (GET): Get the context ID and the insurance policy details. This includes related assets, participants, and coverages. Use query parameters to request additional information.
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.
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.
Individual Enrollment and Policy Adjustment (POST, PUT): Enroll a group census member along with their dependents in the specified group insurance plan and coverages, creating the necessary policy records (POST). Apply mid-term adjustment to manage new hires, terminations or benefits changes due to life events, such as birth, marriage, and promotions (PUT). For both the operations, use the standard flow that manages person account and contact creation, optional pricing, and policy creation or adjustment, or provide a custom flow based on your business needs.
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 Billing Schedules (POST): Create billing schedules from insurance policy transactions to generate financial records for policy lifecycle events.
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 Underwriting Rules (POST): Create an underwriting rule for a root product based on the selected state definition, transition, and object name.
Validate API Request (POST): Validate a JSON request body for the Insurance Quote or Insurance Product Rating API by checking product codes, attributes, instance keys, and required fields against the configured product model.
Validate Attribute Definitions (POST): Validate that attribute definitions exist in the org and are active, and return resolution guidance for any attribute that can’t be validated.
Validate CML Model (POST): Validate the active CML (Constraint Markup Language) model for the specified insurance products and related records. Returns validation status for each specified record along with resolution guidance when the CML configuration is incomplete or inconsistent.
Lookup Error Code (POST): Look up an insurance error code to retrieve its human-readable description, root cause, and step-by-step resolution instructions. Use this resource when a product model validation error is encountered during setup and you need contextual troubleshooting guidance.
Get Rating Input (POST): Generate a sample rating input for the specified insurance product, and use the generated rating input as the request body in the Insurance Product Rating API (/connect/insurance/product-rating) after replacing sample values with real data.
Validate Pricing Setup (POST): Validate pricing configuration, including transaction type resolution, procedure plan existence and effective dates, pricing procedure versions, and the context definition.
Validate Product Discovery (POST): Validate that a product is discoverable at runtime by checking price book entries, selling models, pricing procedures, and decision table configurations.
Validate Product Model (POST): Validate the setup and configuration of insurance product models at design time. Provide a root product ID to check the entire product hierarchy for configuration errors that could cause failures during quoting, rating, or policy issuance.
Validate User Permissions (POST): Validate whether a user has the necessary org-level and user-level permissions to perform an insurance operation, such as creating a quote or policy. If the user isn’t authorized to perform the specified action, the API returns the validation status along with troubleshooting guidance.
Member Policies Adjustment for Contract Endorsement (POST): Apply mid-term contract adjustments to the eligible member policies. 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.
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.
Group Census Member Plan Field Mapper (POST): Map fields on existing member plans for a 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. This API lets you reuse the same census across the quote-to-contract lifecycle and vice versa. The API runs asynchronously and returns a request ID that you can use to track the job status.
Policy Management for Member Mid-Term Adjustment (POST): Apply mid-term adjustments to member policies in bulk to support new hires, terminations, or life events such as birth, marriage, or promotions. You can use the existing flow or provide a custom flow with custom actions. This API runs asynchronously and returns an ID to track the job.
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.
Group Census Cost Impact before Policy Operation (POST): Compare the previous and the current cost for a group census for one member and its associated dependents, or the summary for the entire census, to view the impact of enrollment, adjustment, or renewal before it's finalized. The comparison can cover a single product category or all product categories. You can also compare plan attributes by using this API. By default, the API returns the price comparison details. Set fetchAttributes to true to retrieve plan attribute differences instead of price comparison details.
Policy Renewals (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.
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.
Multi-Root Policy Renewal (POST): Asynchronously renew a multi-root insurance policy, create renewed records for the parent policy and the associated child policies.
Insurance Product Rating Details (POST): Generate rating input details from a list of Product IDs, and use the generated rating input as the request body for the Insurance Product Rating API to evaluate product pricing.
Insurance Quote (POST): Generate a quote or quote-ready context in multiple ways. The API accepts user inputs, generates context, runs rules and pricing, prorates, and then returns a quote ID. The API can also use a context ID to run pricing and rules, update the context, and then return a quote ID. Alternatively, the API can accept user inputs, generate context, run rules and pricing, prorate, and then return only the context ID.
Member Benefits Configuration Override (POST, DELETE): Apply, clone, or revert member-level plan and attribute overrides based on member configuration for quote line items corresponding to root products and coverages. 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.
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 (POST): Create a contract from a quote synchronously, along with contract group plans and attributes, based on the quote configuration for new business.
Multi-Root Policy Issuance (POST): Asynchronoulsy create a multi-root insurance policy along with its child policies. A multi-root policy includes multiple child policies of different product types under a single parent policy.
Plan Benefits (GET, POST, PATCH, DELETE): Get, create, update and delete Insurance Policy Coverage Networks and Insurance Policy Coverage Benefits of an Insurance Policy Coverage.
Plan Benefits Product Model (GET): Get the product model details along with child components and their attributes for a given insurance policy coverage.
Quote Management: Create quotes from existing contracts and apply member-level plan overrides.
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.
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.
Renew Insurance Policy (POST): Use the context ID of an existing policy to renew the policy. Modify the renewal date and also add optional fields and additional information in the request body.
Update Census Information from Policies for Contract (POST): Update a group census with member and optional plan configuration from the active policies on an existing group benefits contract for changes after the last census generation. You can optionally filter based on 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.
Verify Policy Coverage (POST): Verify the applicability of a policy coverage for a specified loss date under an insurance policy, so that only eligible coverages are processed for claims.
Plan Benefits Attributes: Output representation details of the benefits attributes for an insurance policy coverage plan.
Benefits: Output representation details of the plan benefits for an insurance policy coverage plan.
Bulk Pay Claim Coverage Payment Details Response: Output representation of the details of the bulk pay CCPD API call. The API returns a system-generated request ID for tracking asynchronous processing, and any errors reported for the operation.
Calculate Adjustments: Output representation of the details for calculating the adjustments for the claim loss item.
Cancel Policy: Output representation of cancel policy details.
Check Financial Authority: Output representation of evaluating whether the current user has sufficient financial authority to approve a claim coverage payment detail, including whether payment is allowed and the user’s maximum approval amount.
Claim Attribute: Output representation for a claim attribute.
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.
Insurance Attribute Validation Response: Output representation of the per-attribute validation results. Each result reports whether the attribute definition exists and is active, and includes resolution guidance when it isn’t.
Insurance Attribute Validation Result: Output representation of the validation result for one attribute lookup. The result echoes the identifiers from the request and includes resolution guidance when the attribute definition can’t be validated.
Insurance CML Model Validation Response: Output representation of the per-record validation results and any top-level errors that occur when processing the request.
Insurance CML Model Validation Result: Output representation of the validation result for a single record. When the record isn’t valid, the instructions paramter describes the failure and recommended correction.
Insurance Get Rating Input Response: Output representation that contains the generated sample rating input payload as a JSON string, or errors if generation fails.
Insurance Lookup Error Code Response: Response representation that contains the looked-up error code description, optional cause, resolution instructions, and any request-level errors.
Insurance Pricing Setup Validation Response: Output representation of the pricing setup validation result, including whether the pricing configuration is valid and any related errors.
Insurance Product Discovery Validation Response: Output representation of the product discovery validation result, including whether the product’s discovery setup is valid and any related errors or informational messages.
Insurance Product Hierarchy Validation Result: Output representation of the validation result for a single product in the root product hierarchy. The response includes products that failed at least one design-time check.
Insurance Request Validation Response: Response representation that contains the overall request validation result, individual findings, and any request-level errors that prevented validation.
Insurance Request Validation Result: Response representation of a single request validation finding. When the finding isn’t valid, instructions describes the issue and how to resolve it.
Insurance Validate User Permissions Response: Output representation that indicates whether the user has the required permissions for the requested insurance operation, and remediation guidance when they don’t.
Delete Member Plans: Output representation for the member plan deletion process.
Insurance Error: Output representation for an error that occurred during a census management operation.
Insurance Generate Census Response: Output representation of the details when you generate a group census from the policies 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.
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 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.
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 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.
Product Clause Error: Output representation of an error that occurred during the product clause operation.
Insurance Quote: Output representation of the details of the insurance quote.
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.
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.
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.
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.
Plan Benefit Networks: Output representation details of the insurance policy coverage networks.
Out-of-Sequence Endorse Policy: Output representation of the details for the out of sequence policy endorsement process.
Premium Preview Response: Output representation of the details of the draft-state premium preview results for an insurance policy, including per-node rolled-up amounts and any errors.
Premium Preview Amounts: Contains the ten rolled-up Standard and Term premium amount fields returned for a single policy-hierarchy node during a draft-state premium preview.
Premium Preview Result: Output representation of the rolled-up premium amounts or per-node errors for one policy-hierarchy node.
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 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 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 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 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 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.
Remaining Reserve: Output representation for the remaining reserve amount and scope after the payment is processed.
Verify Policy Coverage: Output representation of a policy coverage's applicability for a specified loss date under an insurance policy.
Endorse Multi-Root Policy: Modifies an active multi-root insurance policy by creating new versions of the parent policy and all child policies, regardless of which child policy is changed. The resulting policy versions include recalculated standard and prorated premiums based on the endorsement effective date.
Endorse Multi-Root Policy: Perform a mid-term adjustment on an active multi-root policy when pricing is handled through the Rating API instead of a Salesforce Quote. This process bypasses the creation of a Quote record while ensuring accurate pricing and versioned updates to the parent and child policies.
Endorse Policy: Policy endorsement, also known as Mid-Term Adjustment (MTA), is the process of making modifications to an active insurance policy during its term. Common modifications include adding or removing coverage, or updating policy attributes, such as limits and deductibles. Endorsements usually affect the policy price and create a new policy version instead of updating the existing record. This new version includes the applied changes, along with a recalculated standard premium. It also contains a prorated term premium that’s calculated based on the effective date of the endorsement.
Endorse Policy: Policy endorsement, also known as a Mid-Term Adjustment (MTA), is a process where you change an active insurance policy. The endorsement process changes the policy version and the premiums. This user journey shows you how to endorse a policy when Salesforce's quoting capabilities aren't used.
Insurance Claims Developer Journey: Learn how to effectively use the Insurance Claims Connect APIs, along with the associated invocable actions, to automate end-to-end claims processing workflows, from initial coverage verification to final payment settlement or cancellation by using Salesforce Flows and Omniscripts.
Insurance Brokerage Apex Reference: Apex is a strongly typed, object-oriented programming language that developers can use to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Brokerage Apex reference includes built-in Apex classes and interfaces, grouped by namespace.
Insurance Brokerage Business APIs: Use the Insurance Brokerage Business APIs to manage policy lifecycle, brokerage commissions, and plan benefits.
Requests: Learn about the available Insurance Brokerage API requests.
Resources: Learn about the available Insurance Brokerage API resources.
Responses: Learn about the response bodies of Insurance Brokerage APIs.
ConnectApi Namespace: The ConnectApi namespace (also called Connect in Apex) in Insurance Brokerage provides classes for accessing the same data available in the Insurance Brokerage Business APIs.
Flow for Insurance Brokerage: Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.
Insurance Brokerage Metadata API Types: Metadata API enables you to access some types and feature settings that you can customize in the user interface.
Insurance Brokerage: Use the Insurance Brokerages developer resources to automate processes related to Policy and Commissions Management. Invoke policy lifecycle services such as Renew, Repurpose, and Cancel using context service. Manage plan benefits using a flexible service layer and Product Catalog.
ConnectApi Input Classes: Some ConnectApi methods take arguments that are instances of ConnectApi input classes.
Requests: Learn more about the available requests of insurance claim APIs.
Resources: Learn more about the available Insurance Claims API.
Responses: Learn more about the available response bodies of insurance claim APIs.
ConnectApi Namespace: The ConnectApi namespace (also called Connect in Apex) in Insurance Claim provides classes for accessing the same data available in the Insurance Policy Administration Business APIs.
Flow for Insurance Claims: Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.
Insurance Claims Metadata API Types: Metadata API enables you to access some types and feature settings that you can customize in the user interface.
Insurance Claims Management: Use the Insurance Claims developer resources to set up claim products and create dynamic first notice of loss intake flows for your users. Give claim adjusters a cohesive view of claims and financial data so they can efficiently assess and settle claims. Establish financial controls and automatically route requests for financial approval to the appropriate supervisors and managers.
Insurance Claims Tooling API Objects: Tooling API exposes metadata used in developer tooling that you can access through REST or SOAP. Tooling API’s SOQL capabilities for many metadata types allow you to retrieve smaller pieces of metadata.
Insurance Claims Apex Reference: Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Claims Apex reference includes built-in Apex classes and interfaces, grouped by namespace.
Common Error Codes: Contains the error codes and error code messages that are applicable to all Insurance APIs across all Insurance families.
Insurance Design Advisor: Use Insurance Design Advisor to check your product configuration against everything a quote or policy flow needs. The advisor validates selling models, pricebook entries, pricing procedures, attributes, user permissions, context definitions, and more, and then returns structured validation results with step-by-step remediation guidance. Ask in natural language through Agentforce or use your desired MCP client. Validations run independently and you see every issue in a single pass, rather than discovering them one at a time.
Input Classes: Some ConnectApi methods take arguments that are instances of ConnectApi input classes.
Output Classes: Most ConnectApi methods return instances of ConnectApi output classes.
Insurance Design Advisor Apex Reference: Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Design Advsior Apex reference includes built-in Apex classes and interfaces, grouped by namespace. To use these Apex methods, the org must have Insurance Design Advisor enabled and users must have Digital Insurance Product Administration Management permission set access.
Insurance Design Advisor Business APIs: Use the Insurance Design Advisor Connect APIs at design time to validate product model setup, attributes, pricing configurations, API requests, user permissions, and other related insurance product configurations before using the product at runtime. These APIs only validate the product setup details and don't update any data. To use these APIs, the org must have Insurance Design Advisor enabled and users must have Digital Insurance Product Administration Management permission set access.
Requests: Learn about the available Insurance Design Advisor API requests.
Resources: Learn about the available Insurance Design Advisor API resources.
Responses: Learn about the response bodies of Insurance Design Advisor API responses.
ConnectApi Namespace: The ConnectApi namespace (also called Connect in Apex) in Insurance Design Advisor provides classes for accessing the same data available in the Insurance Design Advisor Business APIs.
Get Started with Insurance Developer Resources: Use the developer resources of Insurance Cloud to manage end-to-end insurance processes. Create and configure quotes, manage policy transactions, and automate processes related to brokerage policies and commissions.
Error Codes and Responses: When using the Insurance APIs, you may encounter error codes and messages under certain conditions. For each family in Insurance, such as Insurance Policy Administration and Quoting, it lists the potential error codes that are related to a specific family and the associated error messages.
ConnectApi Input Classes: Some ConnectApi methods take arguments that are instances of ConnectApi input classes.
Insurance Group Benefits Apex Reference: Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Group Benefits Apex reference includes built-in Apex classes and interfaces, grouped by namespace.
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.
Requests: Learn more about the available requests of insurance group benefits APIs.
Resources: Learn more about the available insurance group benefits API resources.
Responses: Learn more about the available response bodies of insurance group benefits APIs.
ConnectApi Namespace: The ConnectApi namespace (also called Connect in Apex) in Insurance Group Benefits provides classes for accessing the same data available in the Insurance Group Benefits Business APIs.
Flow for Insurance Group Benefits: Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.
Insurance Group Benefits Standard Invocable Actions: Use the standard invocable actions available with Insurance Group Benefits to effectively manage the insurance plans offered to groups, such as employees and their dependents.
Insurance Group Benefits: Group benefits are insurance plans offered to and covering a group of people, such as employees and their dependents. Manage these insurance offerings in a rapidly evolving marketplace with Group Benefits on the Digital Insurance Platform.
Flow for Insurance Policy Administration: Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.
Insurance Policy Administration Apex Reference: Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Policy Administration Apex reference includes built-in Apex classes and interfaces, grouped by namespace.
Insurance Policy Business APIs: Manage policy transactions such as issuance, endorsement, renewal, and cancellation. Calculate term taxes based on transaction types and policy durations.
Requests: Learn more about the available Insurance Policy requests.
Resources: Learn more about the available Insurance Policy API resources.
Responses: Learn more about the available response bodies of Insurance Policy APIs.
ConnectApi Namespace: The ConnectApi namespace (also called Connect in Apex) in Insurance Policy Administration provides classes for accessing the same data available in the Insurance Policy Administration Business APIs.
Insurance Policy Developer Journey: To manage insurance policies by using Salesforce Quoting, use the Quoting APIs to generate a quote context, which serves as the foundation for policy operations. For managing policies without Salesforce Quoting, use the Rating API to create a price-adjusted context. This price-adjusted context provides the necessary rated data to manage insurance policies without depending on a formal quote record.
Insurance Policy Administration: Use the Insurance Policy developer resources to manage insurance policies comprehensively, for different transaction types, such as issuance, endorsement, renewal, and cancellation. Each transaction type creates an InsurancePolicyTransaction record.
Insurance Policy Standard Objects: The Insurance Policy data model provides objects and fields to manage insurance policy transactions.
Flow for Insurance Product Administration: Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.
Insurance Product Administration: Use the Insurance Product Administration developer resources to define the products you sell to customers, including their classifications, categories, and attributes. Create customized price adjustment methods and pricing procedures. Define rules that determine how your products behave when they're quoted, sold, and serviced.
Insurance Quoting Developer Journey: Learn how to use the Insurance Quoting and Rating APIs to build user journeys for creating and updating quotes with Salesforce Flows and Omniscripts. These APIs help you build user journeys for users, such as insurance representatives who use the Salesforce console as well as the policyholders and partners who use the services through community portals.
Insurance Quoting Errors: Contains the error codes and error code messages that are applicable to the Insurance Quoting APIs.
Flow for Insurance Quoting: Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.
Insurance Quoting Metadata API Types: Metadata API enables you to access some types and feature settings that you can customize in the user interface.
Issue Multi-Root Policy: The policy issuance process begins after the policyholder accepts the quote provided by the insurance company. This process creates a parent–child insurance policy structure in which a parent policy serves as a lifecycle container for one or more insured child policies.
Issue Multi-Root Policy: Creates a new multi-root insurance policy when quoting is managed outside Salesforce by a third-party system. This process uses the Rating API to generate a priced context and create a parent–child policy structure without persisting a quote record.
Issue Policy: The policy issuance process begins after the policyholder accepts the quote provided by the insurance company.
Issue Policy: Issue a new insurance policy when quoting is managed outside Salesforce, by a third-party system. This process results in the creation of a policy record in Salesforce, formally establishing coverage for the customer.
Create and Manage Insurance Policies by Using Salesforce Quoting: Learn how to effectively use the Insurance Policy and Quoting Connect APIs, along with the associated invocable actions, to build comprehensive user journeys by using Salesforce Flows and Omniscripts.
Create Out of Sequence Policy Endorsement: Perform a backdated change on a policy in the past, current, or future policy term, even when another policy version with an effective date later than the endorsement date already exists. The impacted policy versions are canceled and replaced with new, repriced versions that include the change. The premium impact for each affected policy term is captured in an individual out-of-sequence endorsement transaction.
Create Out of Sequence Policy Endorsement: Perform a backdated change on a policy in the past, current, or future policy term, even when another policy version with an effective date later than the endorsement date already exists. The impacted policy versions are canceled and replaced with new, repriced versions that include the change. The premium impact for each affected policy term is captured in an individual out-of-sequence endorsement transaction.
Insurance Quoting Business APIs: Create, update, configure, and delete quotes and quote line items. Use the APIs to create guided flows for your external end users.
Requests: Learn more about the available Insurance Quoting requests.
Resources: Learn more about the available Insurance Quoting API resources.
Responses: Learn more about the available response bodies of Insurance Quoting APIs.
Implement Quote Creation Functionality for Insurance Representatives: This user journey applies when a policyholder contacts an insurance company and an insurance representative guides them through identifying coverage needs, configuring and pricing a quote, and sharing it for review.
Renew Multi-Root Policy: Renew a multi-root policy to create a new policy term for the parent policy and all associated child policies. The parent–child policy structure is preserved in the renewed term.
Renew Multi-Root Policy: Creates a new policy term for a multi-root policy when pricing is handled through the Rating API instead of a quote. This process bypasses the creation of a quote record while generating new parent and child policy records for the renewed term.
Renew Policy: Policy renewal is the process of extending insurance coverage for an additional policy term, typically as the current policy approaches its effective-to date. A key part of renewal is that a renewed policy creates a new policy record.
Renew Policy: Policy renewal extends insurance coverage for an additional term, creating a new policy record. This journey details renewing a policy without using Salesforce quoting, relying on the Rating API for pricing the new term.
InsProductClauseVariableMap: Represents the mapping between a token defined in an insurance clause and the product attributes that populate the token value at runtime. For example, a Free Look clause allows a customer to cancel a policy within a certain number of days. The number of days is a variable (or, token) that's populated using product-specific attributes. This object is available in API version 65.0 and later.
InsuranceClause: Defines the terms and conditions associated with a product. For example, an Avocation Clause excludes coverage if the insured engages in a risky hobby. This object is available in API version 65.0 and later.
InsurancePolicyProductClause: Represents all clauses associated with the products that are applicable to a specific insurance policy. The object contains one record for each clause associated with a product that is applicable to a policy. This object is available in API version 65.0 and later.
InsuranceProductClause: Represents a junction between a product and an insurance clause. This association defines the clauses applicable for the specific products. For example, an Excluded Driver clause applies to auto and motorcycle insurance products, but not to home insurance products. This object is available in API version 65.0 and later.
QuoteLineItemInsProductClause: Represents all clauses associated with the products that are applicable to a specific quote line item. For example, if auto insurance quote "ABC" includes both a Free Look clause and an Excluded Driver clause, the object will have two records, one for each clause applicable to the quote line item. This object is available in API version 65.0 and later.
InsPlcyLimitConsumptionRule: Represents configuration for how policy limit consumption applies to an insurance policy product, including consumption mode and product binding. This object is available in API version 67.0 and later.
