Insurance Lookup Error Code Response
Response representation that contains the looked-up error code description, optional
cause, resolution instructions, and any request-level errors.
- JSON example
-
1{ 2 "errorCode": "SF-INS-DSAV-00023", 3 "errorDescription": "The product code is already in use by another product. Use a unique product code.", 4 "errorCause": null, 5 "instructions": "Assign a unique product code to this product. Navigate to the product record and update the ProductCode field to a value that is not used by any other product in the catalog.", 6 "errors": [] 7}
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| errorCause | String | Detailed explanation of the underlying business logic or validation rule that triggered this error. This field is omitted if a cause is unavailable or null. | Big, 68.0 | 68.0 |
| errorCode | String | Error code that’s looked up. | Big, 68.0 | 68.0 |
| errorDescription | String | Human-readable description of the error. For known error codes, this is the registered description. It shows an informative “not found” message if the error code is unrecognized. | Big, 68.0 | 68.0 |
| errors | Insurance Design Advisor Error Response[] | List of request-level validation or processing errors encountered before executing business logic. This list is only shown when the request fails basic validation (such as a missing or blank errorCode). On a successful request, this list is empty. | Big, 68.0 | 68.0 |
| instructions | String | Step-by-step troubleshooting guidance to resolve the error. For known codes with an instructions section, this is the localized instruction text. For unknown codes, this property provides format guidance. | Big, 68.0 | 68.0 |