POLICY_ENDORSE

Passive (internal) call to endorse a policy.

Submit this event using Firing an Event. Product configuration and enabled actions determine the workflow behavior. Use identifiers and snapshots from the same environment.

Request payload#

This compact example is for an administrative endorsement whose configuration has nonRatingEndorsement: true. For a rated endorsement, first request POLICY_ENDORSEMENT_QUOTING, then pass the returned endorsement object here, including its quote and any quoteMap entries. The quote must not be declined.

POST https://api.{ENV}.dais.com/ioi/v3/event/fire

curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/event/fire' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "POLICY_ENDORSE",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "policyId": "<UUID of the policy ID>",
    "documents": [],
    "endorsement": {
      "policyId": "<UUID of the policy ID>",
      "endorsementConfigId": "<UUID of the endorsement configuration ID>",
      "effectiveDate": "2026-04-01",
      "label": "<Label>"
    }
  }
}'

{
  "type": "POLICY_ENDORSE",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "policyId": "<UUID of the policy ID>",
    "documents": [],
    "endorsement": {
      "policyId": "<UUID of the policy ID>",
      "endorsementConfigId": "<UUID of the endorsement configuration ID>",
      "effectiveDate": "2026-04-01",
      "label": "<Label>"
    }
  }
}

Request Fields#

See the shared event envelope. Set type to POLICY_ENDORSE and provide the payload below.

Payload Fields#

Required fields include the inputs used by this event's built-in action. Configured actions can require additional data.

Property	Required	Description
`clientId`	No	UUID of the client linked to the policy.
`quoteId`	No	UUID of the quote.
`policyId`	No	UUID of the policy being endorsed. Must equal `endorsement.policyId`.
`documents`	No	List of documents related to the event.
`endorsement`	Yes	Endorsement data object, including `policyId`, `effectiveDate`, and `endorsementConfigId`. Use the same policy ID as the parent context.
`upfrontAmountToCharge`	No	Amount to charge upfront for the endorsement. Defaults to `0`.
`overrideCalculationMethod`	No	Override calculation method for the endorsement (`CalculationMethod`).
`overrideReason`	No	Reason for overriding the calculation method.

The built-in action resolves the endorsement configuration using endorsement.endorsementConfigId. Supply the configuration associated with this policy and product version. Keep the nested policyId and the parent policy context consistent; configuration rules determine any additional endorsement answers or quote data required.

Response#

This example illustrates the common trigger response structure. Action counts and metadata depend on the actions that run; action-specific result fields are described where applicable.

{
  "triggerRequestId": "<UUID of the trigger request ID>",
  "executedActionCount": 0,
  "expectedResponseCount": 0,
  "metadata": {}
}

Response Fields#

Property	Description
`triggerRequestId`	UUID identifying this trigger execution.
`executedActionCount`	Number of actions reported as executed.
`expectedResponseCount`	Number of expected action responses.
`metadata`	Action-specific results; may be empty.

See Firing an Event for execution modes and response handling.