POLICY_ENDORSE

This event is fired when an endorsement is applied to an existing policy.
It represents the final step of the endorsement process, where the previously quoted changes are confirmed and incorporated into the active policy.
This event ensures that all related updates are officially processed and recorded.

When and what fires this event?

This event is fired internally by the system when an endorsement quote is confirmed and applied to a policy.
It can also be triggered by the user interface when the user finalizes an endorsement through the policy management workflow.

Copilot: fires when the user confirms the endorsement;
API: can fire this event externally on demand.

Request payload

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 <yourAuthHere>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "POLICY_ENDORSE",
  "payload": {
    "policyId": "<UUID of the existing policy>",
    "clientId": "<UUID of the client>",
    "documents": [],
    "event": {
      "eventId": "<UUID>",
      "type": "POLICY_ENDORSE",
      "label": "Add Vehicle Coverage",
      "description": "Policy endorsement applied"
    },
    "policy": {
      "id": "<UUID>",
      "policyNumber": "<string>"
    }
  }
}'

{
  "type": "POLICY_ENDORSE",
  "payload": {
    "policyId": "ce82e6a1-f073-4b6a-9a9f-92c46abf7f90",
    "clientId": "de9f4971-56b4-45a1-bf39-88a34c49a97d",
    "documents": [],
    "event": {
      "eventId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "POLICY_ENDORSE",
      "label": "Add Vehicle Coverage",
      "description": "Policy endorsement applied"
    },
    "policy": {
      "id": "ce82e6a1-f073-4b6a-9a9f-92c46abf7f90",
      "policyNumber": "POL-2024-003"
    }
  }
}

Request fields

Property	Required	Description
`type`	`true`	Must be set to `POLICY_ENDORSE`.
`payload`	`true`	See Payload fields below.

Payload fields

Property	Required	Description
`policyId`	true	UUID of the policy being endorsed.
`clientId`	false	UUID of the client linked to the policy.
`documents`	false	List of documents related to the event.
`event`	false	Element that contains event details.
`policy`	false	Element that contains policy information.

Event fields

Property	Required	Description
`eventId`	false	UUID of the event.
`type`	false	Type of the event (POLICY_ENDORSE).
`label`	false	Label for the event.
`description`	false	Description of the event.

Policy fields

Property	Required	Description
`id`	false	UUID of the policy.
`policyNumber`	false	Policy number.

Response json

The response confirms that the endorsement has been successfully applied and that the system executed the necessary actions.

{
  "success": true,
  "message": "Event fired successfully",
  "data": {
    "triggerRequestId": "37e5b03a-f15f-4a1b-bf4f-3e67d54d42a1",
    "executedActionCount": 2,
    "expectedResponseCount": 1
  },
  "timestamp": "2025-01-17T12:00:00.000Z"
}

Response fields

This response represents the standard event firing wrapper returned by the service.

Property	Required	Description
`success`	`true`	Indicates whether the event firing request completed successfully.
`message`	`true`	Description of the operation result.
`data`	`true`	Contains the trigger execution metadata.
`timestamp`	`true`	Timestamp marking when the response was generated.

Data fields

The data object contains detailed information about the executed trigger.

Property	Required	Description
`triggerRequestId`	`true`	UUID that identifies the trigger execution instance.
`executedActionCount`	`true`	Number of workflow actions that were executed.
`expectedResponseCount`	`true`	Number of responses expected from executed actions.