Skip to content

POLICY_DOCUMENTS_UPLOADED

Document(s) for a policy added.

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 '{
  "lineId": "<UUID of the product ID>",
  "type": "POLICY_DOCUMENTS_UPLOADED",
  "payload": {
    "clientId": "<UUID of the client 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>"
      }
    ]
  }
}'
JSON
{
  "lineId": "<UUID of the product ID>",
  "type": "POLICY_DOCUMENTS_UPLOADED",
  "payload": {
    "clientId": "<UUID of the client 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>"
      }
    ]
  }
}

Request Fields#

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

Payload Fields#

PropertyRequiredDescription
clientIdNoClient identifier associated with the policy and uploaded documents.
policyIdYesTarget policy to which the documents were uploaded.
documents[]NoArray of saved document records attached to the policy.
documents[].nameYesOriginal file name stored with the document.
documents[].extensionYesFile extension (e.g., pdf, png).
documents[].contentIdYesUUID of the CMS content; required for each supplied document.
documents[].urlYesNonblank URL to the stored document.

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.