Skip to content

UPLOAD_POLICY_DOCUMENTS

Upload documents for a policy.

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": "UPLOAD_POLICY_DOCUMENTS",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "policyId": "<UUID of the policy ID>",
    "description": "<Description>",
    "documents": [
      {
        "name": "<Document name>",
        "extension": "pdf",
        "mimeType": "application/pdf",
        "base64EncodedFile": "<Base64-encoded PDF contents>"
      },
      {
        "name": "<Document name>",
        "extension": "pdf",
        "mimeType": "application/pdf",
        "base64EncodedFile": "<Base64-encoded PDF contents>"
      }
    ]
  }
}'
JSON
{
  "lineId": "<UUID of the product ID>",
  "type": "UPLOAD_POLICY_DOCUMENTS",
  "payload": {
    "clientId": "<UUID of the client ID>",
    "policyId": "<UUID of the policy ID>",
    "description": "<Description>",
    "documents": [
      {
        "name": "<Document name>",
        "extension": "pdf",
        "mimeType": "application/pdf",
        "base64EncodedFile": "<Base64-encoded PDF contents>"
      },
      {
        "name": "<Document name>",
        "extension": "pdf",
        "mimeType": "application/pdf",
        "base64EncodedFile": "<Base64-encoded PDF contents>"
      }
    ]
  }
}

Request Fields#

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

Payload Fields#

PropertyRequiredDescription
clientIdYesClient identifier carried through to the follow-up event.
policyIdYesTarget policy UUID.
descriptionNoOptional description stored on the created PolicyEvent.
documents[]NoArray of documents to upload; each supplied item uses the fields below.

Document fields#

PropertyRequiredDescription
documents[].base64EncodedFileYesNonblank Base64-encoded file content. Replace the placeholder with the complete encoded file.
documents[].nameYesFile name for the document (e.g. Binder.pdf).
documents[].extensionYesFile extension without leading dot (e.g. pdf, png).
documents[].mimeTypeYesMIME type of the file (e.g. application/pdf, image/png).

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.