Skip to content

POLICY_CANCEL

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_CANCEL",
    "payload": {
        "clientId": "<clientId>",
        "policyId": "<policyId>",
        "cancellationReasonConfigId": "<cancellationReasonConfigId>",
        "effectiveDate": "<effectiveDate>",
        "label": "<label>",
        "backOfficeIntake": {
            "<qid>": "<answer>"
        }
    }
}'
{
  "lineId": "262e67be-c08c-43c0-bb51-06fe4408b4e9",
  "type": "POLICY_CANCEL",
  "payload": {
        "clientId": "262e67be-c08c-43c0-bb51-06fe4408b4e9",
        "policyId": "24013fc9-65c6-479c-908a-e4ddfc849516",
        "cancellationReasonConfigId": "c074652b-a9db-4c49-87ee-1bc2404af7a0",
        "effectiveDate": "2020-01-13",
        "label": "label",
        "backOfficeIntake": {
            "numEmployees": "17"
        }
    }
}

Event payload fields:

TypeRequiredDescription
lineIdtrueUUID for the associated product
typetrueMust be set to POLICY_CANCEL
payloadtrueExplained below

Payload fields

TypeRequiredDescription
clientIdtrueUUID
policyIdtruePolicy ID
cancellationReasonConfigIdtrueCancellation reason config ID
effectiveDatetrueEffective date
labelfalseLabel
backOfficeIntakefalseMap of qid to answer
Information Circle

Cancellation documents are generated asynchronously. To retrieve them set up a webhook action on the Policy Cancelled event in the platform.