POLICY_DOC_GENERATED

Policy document manual generation completed

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 '{
  "lineId": "<UUID of the product ID>",
  "type": "POLICY_DOC_GENERATED",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "policyId": "<UUID of the policy ID>",
    "documents": [
      {
        "name": "<Document name>",
        "extension": "pdf",
        "contentId": "<UUID of the document content ID>",
        "url": "<Document URL>"
      },
      {
        "name": "<Document name>",
        "extension": "pdf",
        "contentId": "<UUID of the document content ID>",
        "url": "<Document URL>"
      }
    ],
    "referrer": "<Referrer URL>",
    "intake": {
      "<Employee count question ID>": {
        "type": "ANSWER",
        "answer": "42",
        "qid": "<Employee count question ID>"
      }
    },
    "intakeLoopIterationIdsToDelete": [],
    "metadata": {
      "generationBatchId": "<Generation batch ID>"
    },
    "integrationData": {
      "docProvider": "<Document provider>"
    }
  }
}'

{
  "lineId": "<UUID of the product ID>",
  "type": "POLICY_DOC_GENERATED",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "policyId": "<UUID of the policy ID>",
    "documents": [
      {
        "name": "<Document name>",
        "extension": "pdf",
        "contentId": "<UUID of the document content ID>",
        "url": "<Document URL>"
      },
      {
        "name": "<Document name>",
        "extension": "pdf",
        "contentId": "<UUID of the document content ID>",
        "url": "<Document URL>"
      }
    ],
    "referrer": "<Referrer URL>",
    "intake": {
      "<Employee count question ID>": {
        "type": "ANSWER",
        "answer": "42",
        "qid": "<Employee count question ID>"
      }
    },
    "intakeLoopIterationIdsToDelete": [],
    "metadata": {
      "generationBatchId": "<Generation batch ID>"
    },
    "integrationData": {
      "docProvider": "<Document provider>"
    }
  }
}

Request Fields#

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

Payload Fields#

Property	Required	Description
`clientId`	No	The client associated with the policy.
`quoteId`	No	UUID of the quote.
`policyId`	No	The target policy for which documents were generated.
`documents[]`	No	List of document objects that were generated.
`documents[].name`	Yes	File name of the generated document.
`documents[].extension`	Yes	File extension (e.g., pdf, docx).
`documents[].contentId`	Yes	UUID of the document stored in CMS; required for each supplied document.
`documents[].url`	Yes	Public or internal URL to the stored file.
`referrer`	No	Optional string value to track a referral.
`intake`	No	Map of question identifiers to client answers.
`intakeLoopIterationIdsToDelete`	No	Set of intake loop iteration UUIDs to remove.
`metadata`	No	Additional metadata map.
`integrationData`	No	Integration-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.

{
  "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.