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.
| Available in: Lightning Experience |
| Available in: Enterprise, Unlimited, and Developer Editions |
This table lists the available Insurance Design Advisor resources.
| Resource | Description |
|---|---|
| /connect/insurance/design-advisor/api-request-validation (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. |
| /connect/insurance/design-advisor/attribute-validation (POST) | Validate that attribute definitions exist in the org and are active, and return resolution guidance for any attribute that can’t be validated. |
| /connect/insurance/design-advisor/cml-model-validation (POST) | Validate the active CML (Constraint Markup Language) model for the specified insurance products and related records, and return resolution guidance when the CML configuration is incomplete or inconsistent. |
| /connect/insurance/design-advisor/error-code-lookup (POST) | Look up an insurance error code and return its description, root cause, and step-by-step resolution instructions. |
| /connect/insurance/design-advisor/get-rating-input (POST) | Generate a sample rating input for the specified insurance product to use as the request body in the Insurance Product Rating API after replacing sample values with real data. |
| /connect/insurance/design-advisor/pricing-setup-validation (POST) | Validate pricing configuration, including transaction type resolution, procedure plan existence and effective dates, pricing procedure versions, and the context definition. |
| /connect/insurance/design-advisor/product-discovery-validation (POST) | Validate that a product is discoverable at runtime by checking price book entries, selling models, pricing procedures, and decision table configurations. |
| /connect/insurance/design-advisor/product-model-validation (POST) | Validate the setup and configuration of insurance product models at design time, including the product hierarchy for configuration errors that could cause failures during quoting, rating, or policy issuance. |
| /connect/insurance/design-advisor/user-permissions-validation (POST) | Validate whether a user has the necessary org-level and user-level permissions to perform an insurance operation, and return troubleshooting guidance when the user isn’t authorized. |