ENDORSEMENT_ACTIVATED

Endorsement's effective date is reached, and endorsement is now in effect.

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#

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": "ENDORSEMENT_ACTIVATED",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "clientId": "<UUID of the client ID>",
    "documents": [
      {
        "name": "<Document name>",
        "extension": "pdf",
        "contentId": "<UUID of the document content ID>",
        "url": "<Document URL>"
      }
    ],
    "event": {
      "eventId": "<UUID of the policy event ID>",
      "type": "ENDORSEMENT",
      "label": "<Label>",
      "description": "<Description>"
    },
    "policy": {
      "id": "<UUID of the policy ID>",
      "policyNumber": "<Policy number>",
      "issuingOrganizationId": "<UUID of the issuing organization ID>",
      "sellerOrganizationId": "<UUID of the seller organization ID>",
      "clientId": "<UUID of the client ID>",
      "quoteId": "<UUID of the quote request ID>",
      "productId": "<UUID of the product ID>",
      "premium": 4200.0,
      "effectiveDate": "2026-11-01",
      "expirationDate": "2027-11-01",
      "lastDayWithCoverage": "2027-10-31",
      "asRatingConfiguredAtTimestamp": "2026-10-01T00:00:00Z"
    }
  }
}'

{
  "type": "ENDORSEMENT_ACTIVATED",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "clientId": "<UUID of the client ID>",
    "documents": [
      {
        "name": "<Document name>",
        "extension": "pdf",
        "contentId": "<UUID of the document content ID>",
        "url": "<Document URL>"
      }
    ],
    "event": {
      "eventId": "<UUID of the policy event ID>",
      "type": "ENDORSEMENT",
      "label": "<Label>",
      "description": "<Description>"
    },
    "policy": {
      "id": "<UUID of the policy ID>",
      "policyNumber": "<Policy number>",
      "issuingOrganizationId": "<UUID of the issuing organization ID>",
      "sellerOrganizationId": "<UUID of the seller organization ID>",
      "clientId": "<UUID of the client ID>",
      "quoteId": "<UUID of the quote request ID>",
      "productId": "<UUID of the product ID>",
      "premium": 4200.0,
      "effectiveDate": "2026-11-01",
      "expirationDate": "2027-11-01",
      "lastDayWithCoverage": "2027-10-31",
      "asRatingConfiguredAtTimestamp": "2026-10-01T00:00:00Z"
    }
  }
}

Request Fields#

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

Payload Fields#

Property	Required	Description
`policyId`	Yes	UUID of the policy.
`clientId`	No	UUID of the client associated with the policy.
`documents`	No	List of documents related to the event.
`event`	No	Containing event details.
`policy`	No	Containing policy information.

Event Object Fields#

Property	Required	Description
`eventId`	No	UUID of the event.
`type`	No	Type of the event.
`label`	No	Label for the event.
`description`	No	Description of the event.

Policy Object Fields#

The parent policy snapshot is optional for this event. When supplied, use a complete Policy API object. Its required fields include id, policyNumber, organization and client identifiers, quoteId, productId, numeric premium, policy dates, and asRatingConfiguredAtTimestamp. Use the policy identified by the surrounding policyId.

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.