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.

Use this resource at design time to resolve an insurance error code such as SF-INS-DSAV-00001. Provide the error code string. The API matches it against registered insurance error codes and returns the description, optional cause, and resolution instructions.

When the error code is known, the response includes the registered description and, when available, localized resolution instructions. When the error code isn’t registered, the API still returns HTTP status 200 with an informative “not found” description and format guidance in instructions.

When required input is missing, errors can include request-level failures such as:

SF-INS-DSAV-00040 — the error code wasn’t specified. Provide a valid insurance error code. Returned with HTTP status 400 when errorCode is null, blank, or the request body is missing.

Insufficient access, or Design Advisor not enabled for the org, returns HTTP status 403. An unexpected failure returns HTTP status 500.

Resource

1/connect/insurance/design-advisor/error-code-lookup

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/error-code-lookup

Available Version

68.0

HTTP Methods

POST

Request Body for POST

JSON Example

1{
2  "errorCode": "SF-INS-DSAV-00023"
3}

Properties

Name	Type	Description	Required or Optional	Available Version
`errorCode`	String	The unique alphanumeric insurance error code identifier to look up. Must follow the `SF-INS-XXX-NNNNN` format, for example, `SF-INS-DSAV-00023` and `SF-INS-COM-00009`.	Required	68.0

Response Body for POST

Insurance Lookup Error Code Response