Skip to content

POLICY_RENEWED

Called when the policy has been renewed and becomes effective.

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#

HTTPPOST
POST https://api.{ENV}.dais.com/ioi/v3/event/fire
cURL
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_RENEWED",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request 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": "RENEWAL"
    },
    "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"
    },
    "metadata": {
      "renewalTerm": 12,
      "renewalPremium": 5775.0
    },
    "integrationData": {
      "externalRenewalRef": "<External renewal reference>"
    }
  }
}'
JSON
{
  "type": "POLICY_RENEWED",
  "payload": {
    "policyId": "<UUID of the policy ID>",
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request 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": "RENEWAL"
    },
    "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"
    },
    "metadata": {
      "renewalTerm": 12,
      "renewalPremium": 5775.0
    },
    "integrationData": {
      "externalRenewalRef": "<External renewal reference>"
    }
  }
}

Request Fields#

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

Payload Fields#

PropertyRequiredDescription
policyIdYesUUID of the renewed policy.
clientIdNoUUID of the client associated with the policy.
documentsNoList of documents related to the event.
eventNoPolicy event details.
policyNoPolicy snapshot object. Use the same policy as policyId.
quoteIdNoUUID of the quote used for renewal.
metadataNoAdditional metadata map.
integrationDataNoIntegration-specific data map.

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.

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

Response Fields#

PropertyDescription
triggerRequestIdUUID identifying this trigger execution.
executedActionCountNumber of actions reported as executed.
expectedResponseCountNumber of expected action responses.
metadataAction-specific results; may be empty.

See Firing an Event for execution modes and response handling.