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.

Use this resource at design time to validate a root insurance product and every associated product in its hierarchy, including direct children, component groups, and classification-based children. The API checks configuration that would otherwise surface as runtime failures during quoting, rating, or policy issuance.

Validations include confirming that each product is active; that the product code is specified, is a single word, and is unique; that an active record type and product specification record type mapping are present; that root-level product type is Base, Bundle, or Set; that BasedOnId points to a valid product classification; that an active product selling model and price book entry are associated; that attribute definitions have non-blank developer names and unique codes; that extended attribute reference object and field are set together and resolve in metadata; that the root product is associated with a catalog category; and that the hierarchy has no cycles or forbidden parent-child specification-type pairings.

When every product in the hierarchy passes validation, isValid is true. When one or more products fail, isValid is false and products lists the related products that have configuration errors. Those per-product failures are returned in the response body with HTTP status 200. Examples include:

SF-INS-DSAV-00001 — the product isn’t active.
SF-INS-DSAV-00004 — the product isn’t associated with a product selling model option.
SF-INS-DSAV-00011 — the product doesn’t have a price book entry.
SF-INS-DSAV-00014 — the product doesn’t have a record type assigned.
SF-INS-DSAV-00027 — the product hierarchy contains a circular reference.

Top-level errors are returned in errors when the request can’t be validated per product. A missing productId returns SF-INS-DSAV-00013. A blank, malformed, or invalid Product2 ID returns SF-INS-DSAV-00012. Insufficient access, or Digital Insurance not enabled for the org, returns INSUFFICIENT_ACCESS with HTTP status 403. An unexpected failure returns INTERNAL_SERVER_ERROR with HTTP status 500.

Resource

1/connect/insurance/design-advisor/product-model-validation

Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/product-model-validation

Available Version

68.0

HTTP Methods

POST

Request Body for POST

JSON Example

1{
2  "productId": "01txx0000006iPnAAI"
3}

Properties

Name	Type	Description	Required or Optional	Available Version
`productId`	String	ID of the root insurance product for which you want to validate the model setup. The API validates this product and all associated products in its hierarchy, including direct children, component groups, and classification-based children.	Required	68.0

Response Body for POST

Insurance Product Model Validation Response