Insurance Services Catalog

Get quote, policy, and claims systems up and running by using an extensive catalog of Digital Insurance Platform services. The services are methods of Apex classes that carry out common actions for insurance companies and health plans. They help you build end-to-end business processes faster by reducing or eliminating the need for custom programming.

Service Model Basics

Services support the Vlocity Open Interface protocol with the same call signature. Service detail topics each include a section for Remote Options, Input JSON, and Output JSON. To learn more about a specific service, click its method name.

Central to an understanding of services is an understanding of the product definition. Product administrators set up products with coverages, insured items, and rating facts, and map rating procedures in the product definition.

Insurance has a defined JSON product object model that is the JSON description of a product as it is set up in Salesforce. JSON product objects are used by many services and templates to pass runtime product data between them.

See Product JSON Structure Model for more information.

Explore a Service

To try a service on your own, add a Remote Action element to an OmniScript or Integration Procedure. Then add any of the services in this catalog to the Remote Action and preview your OmniScript to see how it works.

Service Listings by Class

Review service listings by class.

Quote, Policy, Claims, and Group Benefits Service Listing by Class

These services apply to quote, policy, claims administration. This listing also includes group benefits services in the Vlocity Health and Vlocity Insurance managed package.
Group Benefits Standard Service Listing by Class

These services apply to group benefits in the Salesforce data model.

Quote, Policy, Claims, and Group Benefits Service Listing by Class

These services apply to quote, policy, claims administration. This listing also includes Group Benefits services in the Vlocity Health and Vlocity Insurance managed package.

Classes/Methods	Description
ActionListService
processOnCreateActions	Executes the `OnCreate` Vlocity Action set at the State Model version of the object.
HealthFeeScheduleDataService Important These services are retired from Vlocity Health and Vlocity Insurance Spring '22 release and onwards.
getBaseFees	This service retrieves the currently active base fee schedule data—Description, Facility Price, and Non-Facility Price, and so forth—based on the date specified.
getProviderFees	This service retrieves data for the currently active provider fee schedule based on the specified date.
InsAsyncBulkService
getRequestStatusById	Use this service to get the status of the async bulk request and its details associated with the request.
getRequestStatusByUser	Use this service to get the status of async bulk requests and information about the associated async request items.
InsCensusService
addMembers	Use this service to add members to a census via JSON.
addPlanSelections	Use this service to insert pre-enrolled plans for each member specified in the input.
cloneCensus	Use this service to clone a census and all the census members.
ConvertLeadAnd CreateCensus	Use this service to extend the Lead Conversion Salesforce feature, allowing users to include Lead census information and map this data to the Vlocity Group Account Census objects while converting the Lead.
createAccounts	Create Person Accounts for members in the given census.
createContacts	Creates Contacts for census members, and also creates community (portal) users.
deleteMembers	Use this service to delete the members from a census.
getFields	Retrieves field definitions and field API names for group census members and group census plans.
getMemberRatingFacts	This service retrieves rating fact data for census members, for use as user Inputs for the getRatedGroupProducts service.
getMembers	Use this service to retrieve the first 2,000 census members of the given census.
getMembersWithPlans	Use this service to retrieve members of a census and their pre-enrolled plans as well as field definitions for the `GroupCensusMember__c` and `GroupCensusMemberPlan__c` fields.
getQualifiedCensusMembers	Use this service to retrieve members that qualify for rating per family. Filters out dependents based on age, region, number of dependents.
sendMassEmail	Sends all employees in a census an email, kicking off an enrollment process.
setCensusRatingFacts	Associates a Rating Fact spec to a census.
setMemberRatingFacts	Associates a Rating Fact spec to a census member.
updateMembers	Use this service to update all the members listed to the values in the JSON.
updateMembersWithPlans	Use this service to populate a census with primary members, their dependents, and their pre-enrolled plan.
InsClaimCoverageService
createUpdateCoverage	Creates a new claim coverage or updates an existing claim coverage.
invokeProductRules	Runs rules for the claim coverage.
InsClaimItemService
add	Adds a claim line item to a specified claim item object.
calculateCoverages	Calculates the payment amount for a claim line item.
cancelPayments	Cancels claim loss and expense payments.
claimCoverageValuation	Verifies that users have the authority to pay or approve amounts in different types of financial activities.
createPayments	Creates and saves claim payment records based on the line item IDs and the `groupPayments` option.
delete	Deletes a claim line item from a claim object.
getClaimItems	Retrieves claim line items from a specified claim.
getClaimLineItemFields	Gets a list of fields and values for claim line items in a specified claim.
getCoverages	Gets coverages that apply to a specific claim.
getInsuranceCodes	Gets a list of insurance codes that correspond to the coverages associated with claims.
getInvolvedItems	Returns a list of involved items (property) and/or involved people (parties) for a specific claim.
invokeInitiatePaymentIP	Initiates loss or expense payments.
saveInvolvedItem	Updates the total reserve amount of an involved property or involved injury record.
update	Updates a claim line item to a specified claim item object.
InsClaimRecoveryService
getRecoveries	Gets a list of claim recoveries (InsuranceClaimRecovery__c) based on a specified claim Id or claim number.
save	Accepts an input of a list of information, which is transformed to create and update records for the InsuranceClaimRecovery__c, an object that represents the recovery of funds for a claim.
InsClaimService
createUpdateClaim	Creates or updates a claim.
createUpdateClaimRecoveries	Use this service to create or update records that represent a recovery of funds on an insurance claim.
getClaimRecoveries	Use this service to get a list of claim recoveries for a claim.
getRuleLogs	Retrieves rule logs for a target quote, sorted by execution date in ascending order.
invokeProductRules	Invokes a set of underwriting rules for a product.
invokeRules	Invokes state transition rules associated with a target state transition on a target claim.
verifyCoverage	Verifies valid insurance coverage for a policyholder who is filing a claim.
InsCommissionService
adjust	Adjusts a commission based on user inputs.
calculate	Calculates the commission for a producer.
InsContractService
createLargeSizeRenewQuoteInBatch	This service allows for the control of how many Apex jobs to initiate, and the number of batches to run per Apex job, for contracts with a large number of root line items.
createRenewQuotesInBatch	This service allows you to control how many Apex jobs to initiate, and the number of batches to run per Apex job, for a large number of contract renewals.
createUpdateContract	Creates a contract or updates an existing contract.
getContractDetail	Calls a contract record.
invokeProductRules	Invokes a set of underwriting rules for a product.
InsEnrollmentService
enrollMembers	This service enrolls census members into their selected plans.
enrollPlans	Creates all policies for enrollment.
findEnrollees	Allows a user to search for a list of enrolled clients.
getEligibleMemberProducts	This service returns eligible products for members of a census and groups them by type.
getEnrolleePolicies	This service allows a user to search for the policies of given enrolled clients.
>getMemberEnrollments	This service retrieves current enrollments for a member so they can make benefit changes. It also takes one or more census member Ids and returns enrolled plans for the member and its dependents.
getRatedProducts	Pulls contract-based eligible policies with prices for the active user.
modifyEnrollment	This service is used to modify the enrollments, dependents, and coverages of each enrollment for input members.
InsFormularyService
getListOfCoveredDrugs	Use this service to get a list of brand name or generic drugs in a formulary that are part of a health plan.
getListOfDrugs	Use this service to get a list of drugs within their effective marketing dates.
getListOfPlanMedicationPrices	Use this service to get a list of prices for covered drugs within a provider network, including copay calculation.
getProducts	Use this service to facilitate the process of retrieving eligible products linked to Formularies, which contains medications (`drugs`) where the customer (`accountId`) medications are included.
InsGroupClassService
getGroupClassByAccount	Fetches the Group Classes associated with the given `AccountId`.
getGroupClassesByContract	Use this service to get a list of eligible plans with the `contractId` that's provided as input, and a list of eligible plans for the GroupclassId that's provided as input.
InsPolicyBillingService
generateBillingAccountStatements	Generates billing statements for accounts.
generateDirectBillingStatements	Generates statements for direct billing.
InsPolicyRevenueScheduleService
cancelRevenueSchedule	Adjusts the last revenue schedule line item, calculating revenue based on the cancellation date of the canceled policy.
createRevenueSchedule	Creates a monthly revenue schedule for a policy, starting on the effective date of the policy and ending on the expiration date.
modifyRevenueSchedule	Takes in the modifications done to the policy. Based on the changes to total policy premium and the modification date, it recalculates the revenue schedule to adjust the monthly premiums (earned and unearned revenue).
InsPolicyTermsService
getCurrentStanding	Gets a list of amounts that represent the current standing of the policy terms associated with a policy or a claim.
InsPolicyService
calculateTaxesAndFees	Use this service to calculate and save taxes and fees on a target asset (policy).
cancelPolicy	Cancels a policy.
createMultiRootPolicy	Issues a multi-root policy from a quote.
createMultiRootPolicyVersion	Endorses a multi-root policy from an endorsed quote.
createOutOfSequencePolicyVersion	Initiates an out-of-sequence endorsement for a given policy.
createPolicyVersion	Creates a new version of an existing policy, while leaving the original policy record as is.
createPaymentSchedule	Creates a payment schedule for the policy.
createReinstatementPolicy	Reinstates a canceled policy.
createRenewalPolicy	Creates a renewal policy from an existing policy.
createRenewalQuote	Creates a renewal quote for an existing policy.
createTransaction	Creates a new transaction for a policy.
createUpdatePolicy	Creates or updates a policy and its insured items.
createPolicyTerms	Creates policy terms in the AssetTerm__c object for all the power attributes at the Asset and AssetCoverage level.
getInsuredItems	Gets insured items from a policy.
getModifiedPolicy	Gets the policy as it has been modified by user inputs.
getOutOfSequenceEndorsementStatus	Retrieves the current status of the OutOfSequenceEndorsement async job.
getPaymentSchedule	Retrieves the payment schedule.
getPolicyAsyncJobStatus	Fetches the status of the asynchronous batch job. .
getPolicyDetails	Gets the policy (asset) object.
getPolicyVersions	Retrieves the different versions of a policy.
getRuleLogs	Retrieves rule logs for a target policy, sorted by execution date in ascending order.
initiateLapseGracePeriod	Initiates a grace period after a policy lapses, but before it gets canceled.
invokeProductRules	Invokes a set of underwriting rules for a product.
modifyPaymentSchedule	Modifies the payment schedule of this policy.
prepareToCancelPolicy	Calculates the difference between the original premium and the premium up to the cancellation date.
prepareToRenewPolicy	Calculates the amount required for renewing an existing policy. This service returns renewal premium, taxes, and fees, or the renewal policy JSON without creating a policy.
removeInsuredItem	Removes an insured item from a policy record.
renewPoliciesInBatch	Controls the number of Apex jobs to initiate, and the number of batches to run per Apex job, for a large number of policy renewals.
verifyCoverage	Verifies that an insurance policy includes coverage on the date the claim is filed for properties and injuries claimed.
InsProductAsyncService
fetchProductsPrice	Fetches asynchronous rating results.
fetchRepriceProductPrice	Fetches asynchronous rating results for a reprice product request.
repriceProduct	Asynchronously recalculates the price of a product based on `selectedProduct` JSON and `userInput`.
startAsyncRating	Asynchronously calculates product prices based on a list of product IDs.
InsProductJSONService
getAttributes	Gets the attributes from a specified product JSON.
getCoverageChanges	Use this service for renewals, to get the coverage changes between two product JSONs.
getCoverages	Gets the coverages from a specified product JSON.
trimOffAttributeCategory	Makes the product JSON smaller by removing the attribute categories. Leaves attribute values in place.
updateUserValues	Use this service to update the `userValues` of specified attributes in a product JSON, based on changes a user has made.
InsProductReportService
getReportData	Retrieves all product fields and attributes for a given set of Ids and field sets.
InsProductService
cloneProduct	Clones a product.
getEligibleProducts	Use this service to find and return a list of products that match the criteria you specify.
getCoverages	Use this service to get all the coverages for a product spec.
getRatedGroupProducts	Used only with group products that use census, which allows the products to be kept with the product service.
getRatedProducts	Queries for eligibility products, runs through the calculation procedure, and returns a price and coverages.
repriceProduct	Updates pricing based on changes in user values.
runRules	Runs rules on a product without repricing that product.
InsProviderNetworkService Important These services are retired from Vlocity Health and Vlocity Insurance Winter '22 release:
cloneNetwork	Use this service in an OmniScript to clone a Provider Network.
getProviders	Use this service to get a list of Providers and Provider Networks, based on contact name, postal code, or profile attributes.
getProvidersByArea	Use this service to retrieve all providers and their networks for a given geographical location. Both individual and organizational providers are returned along with the networks they are a member of, by using `state` and `postalCode` as inputs.
getProvidersByNameOrNPI	This service allows users to search for providers using a search key.
getProvidersDetail	This service allows user to retrieve provider information including its group affiliations and locations.
InsQuoteService
addInsuredItem	Use this service to add insured items to quotes.
calculateTaxesAndFees	Use this service to calculate and save taxes and fees on a target quote.
cloneQuote	Use this service to clone a quote.
createEndorsementQuote	Creates an endorsement quote with quote line items for single-root and multi-root policies.
createUpdateQuote	Use this service to create a quote for an insurance policy, or update an existing quote with new information.
createUpdateQuoteFromExternal	Use this service to create a quote or update an existing quote with new information through an inbound API call from an external system.
getAccountQuotes	Use this service to retrieve quote records associated with an `accountId`.
getPlanSpecs	Use this service to get all the quote line items (that is to say, the plan specs) associated with a specific product.
getProductSpecs	Use this service in an OmniScript to get a list of specific product specs used in a quote, at the QuoteLineItem level, and which includes product information.
getRuleLogs	Use this service to retrieve rule logs for a target quote, sorted by execution date in ascending order.
getQuoteDetail	Use this service to get all the quote details in a JSON.
getQuoteVersions	Use this service to retrieve different versions of a quote based on its Opportunity Id, and then returns a list of quotes based on the Quote field set QuoteCompareHeader.
invokeProductRules	Use this service in quote flows to invoke underwriting rules you've added to a product.
invokeRules	Use this service to invoke state transition rules associated with a target state transition on a target quote.
priceLargeGroupRootItems	Calculates the price, and optionally taxes and fees, for a specific root item or all root items for a large group quote.
priceRootItem	Calculates the price for a target root item and its children in a quote.
recalculateRollupFormulas	This service sums the price at the child or grandchild quote line item level and recalculates it to the parent quote line item level.
removeCoverage	Use this service in an OmniScript to remove a specified coverage, as per the product code, from the quote. Can be used on multiple plans.
updateQuoteLine	Use this service to update items on the quote.
updateQuotePlans	Use this service in an OmniScript to add, update, or upsert (add and update) either coverages or attributes for one or more plans across a quote.
InsScheduledAutomatedTransitionService
scheduleAutomatedTransition	Use this service to automate the transition by scheduling an object state transition, from an origin state to a target state (Vlocity States), using hourly, daily, or weekly patterns.
StateRuleService
invokeRules	Invokes state transition rules associated with a target state transition on a target object.
getRuleLogs	Retrieves rule logs for a target object, sorted by execution date in ascending order.
getTransitionStates	Gets default transition states, the To state of each from state transition, the current state, and the last default state for the target object.
InsTrailingDocumentService
uploadContentDocuments	Add this service as remote properties within File and Image inputs to upload documents that satisfy requirements set up as placeholders for specific objects.
InsurancePolicyTransactionService
reverseTransaction	Reverses an insurance policy transaction
InsVlocityActionService
assignRecordToQueue	Use this service to assign a record to the specified Salesforce queue.
notifyApplicant	Use this service to send an email notification to applicants. This service is used in Vlocity State Model workflows when the Vlocity Actions are configured.

Group Benefits Standard Service Listing by Class

These services apply to group benefits in the Salesforce data model.

Classes/Methods	Description
InsCensusServiceStd
addMembers	Use this service to add group census members to a group census using an input JSON.
addPlanSelections	Use this service to create `GroupCensusMemberPlan` records for existing `GroupCensusMember` records.
createContacts	Use this service to create Contacts for census members.
createUpdateAccounts	Use this service to create Person Accounts for the members in the given census. It also updates the existing person accounts using the `duplicateKeys` parameter.
deleteAllMembers	Deletes all group census members of the group census passed as input into the service.
deleteMembers	Use this service to delete the group census members.
deleteMembersWithPlans	Use this service to delete the group census members and the associated plans.
findAccounts	Searches for existing person accounts by first name, last name, and email, or by a search key and group account.
findContacts	Searches for existing contacts by first name, last name, and email, or by a search key and group account.
getFields	Use this service to retrieve field definitions and field API names for group census members and group census member plans.
getMembers	Use this service to retrieve the members of a census from the `GroupCensusMember`. It also retrieves the headers based on the `fieldsetName`.
getMembersWithPlans	Use this service to retrieve the list of census members for a given `censusId`.
setCensusRatingFacts	Use this service to set `AttributeSelectedValues` on the `GroupCensus` record based on the rating fact passed to the service.
setMemberRatingFacts	Use this service to set `AttributeSelectedValues` on the `GroupCensusMember` records based on the rating fact passed to the service.
updateMembers	Use this service to update the values of existing members in a census.
updateMembersWithPlans	Use this service to populate a group census with primary members, their dependents, and their pre-enrolled plan.
InsContractServiceStd
createUpdateContract	Use this service to create or update a contract for the given quote.
InsEnrollmentServiceStd
enrollFamily	Use this service to enroll one family within one root plan that includes a primary member and associated dependents with coverages.
enrollMembers	Use this service to enroll census members into their selected plans.
enrollMembersAsync	Enrolls large groups of members.
enrollNewHires	Enrolls new census members into their selected plans in the middle of a contract term.
enrollPlans	Use this service to create insurance policy (`InsurancePolicy`) records for member's selected medical, dental, vision, and other plans.
getMemberEnrollments	Use this service to retrieve current enrollments for a member. This service takes one or more census member Ids and returns enrolled plans for the member and associated dependents.
getPolicyDetails	Retrieves Insurance Policy records for Primary Group Census Members.
getRatedGroupProducts	Use this service to calculate price to opt for a root plan with coverages for a family. The service also provides employee and employer contributions for a policy before enrollment, and supports proration for new hires.

ActionListService Methods
This is the available ActionListService method.
HealthFeeScheduleDataService Methods
These are the available HealthFeeScheduleDataService methods.
InsAsyncBulkService Methods
These are the available InsAsyncBulkService methods.
InsCensusService Methods
These are the available InsCensusService methods.
InsCensusServiceStd Methods
These are the available InsCensusServiceStd methods.
InsClaimCoverageService Methods
Create coverages, update coverages, and run state transition rules when creating coverages with the help of the claim coverage service methods.
InsClaimItemService Methods
Manage claim line items, calculate coverages, process and cancel payments, and gather information about parties on a claim with the help of the claim item service methods. If you use a payment authorization workflow, use a service method to verify a team member's authority to pay or approve a financial amount.
InsClaimRecoveryService Methods
Get a list of claim recoveries and update the records that represent the recovery of funds for a claim with the help of the claim recovery service methods.
InsClaimService Methods
Create and update claims, verify coverages, recover funds on claims, and run underwriting and state transition rules with the help of the claim service methods.
InsCommissionService Methods
These are the available InsCommissionService methods.
InsContractService Methods
These are the available InsContractService methods.
InsContractServiceStd Methods
These are the available InsContractServiceStd methods.
InsEnrollmentService Methods
These are the available InsEnrollmentService methods.
InsEnrollmentServiceStd Methods
These are the available InsEnrollmentServiceStd methods.
InsFormularyService Methods
These are the available InsFormularyService methods.
InsGroupClassService Methods
These the available InsGroupClassService methods.
InsPolicyBillingService Methods
These are the available InsPolicyBillingService methods.
InsPolicyRevenueScheduleService Methods
These are the available InsPolicyRevenueScheduleService methods.
InsPolicyService Methods
These are the available InsPolicyService methods.
InsPolicyTermsService Methods
Track the financial status of policy terms for claims with the help of the policy term service methods.
InsProductAsyncRatingService Methods
These are the available InsProductAsyncRatingService methods.
InsProductJSONService Methods
These are the available InsProductJSONService methods.
InsProductReportService Methods
These are the available InsProductReportService methods.
InsProductService Methods
These are the InsProductService methods.
InsProviderNetworkService Methods
These are the available InsProviderNetworkService methods.
InsQuoteService Methods
These are the available InsQuoteService methods.
InsScheduledAutomatedTransitionService Methods
These are the available InsScheduledAutomatedTransitionService methods.
StateRuleService Methods
These are the available StateRuleService methods.
InsTrailingDocumentService:uploadContentDocuments
Add this service as remote properties within File and Image inputs to upload documents that satisfy requirements set up as placeholders for specific objects.
InsurancePolicyTransactionService Methods
These are the available InsurancePolicyTransactionService methods.
InsVlocityActionService
These are the available InsVlocityActionService methods.

Did this article solve your issue?

Let us know so we can improve!

Insurance Services Catalog

Service Model Basics

Explore a Service

Service Listings by Class

Quote, Policy, Claims, and Group Benefits Service Listing by Class

Group Benefits Standard Service Listing by Class

General Information

Required Cookies

Functional Cookies

Advertising Cookies

General Information

Required Cookies

Functional Cookies

Advertising Cookies

Cookie List

Product Area

Feature Impact

Edition

Experience

Insurance Services Catalog

Service Model Basics

Explore a Service

Service Listings by Class

Quote, Policy, Claims, and Group Benefits Service Listing by Class

Group Benefits Standard Service Listing by Class