Skip to content

CLIENT_VALIDATION_FAILED

Called when a customer's identity is failed for compliance issues

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": "CLIENT_VALIDATION_FAILED",
  "payload": {
    "referrer": "<Referrer URL>",
    "intake": {
      "<Employee count question ID>": {
        "type": "ANSWER",
        "answer": "55",
        "qid": "<Employee count question ID>"
      },
      "<Claims in the last two years question ID>": {
        "type": "ANSWER",
        "answer": "5",
        "qid": "<Claims in the last two years question ID>"
      }
    },
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "policyId": "<UUID of the policy ID>",
    "documents": [],
    "intakeLoopIterationIdsToDelete": [],
    "metadata": {
      "validationFailureReason": "OFAC_HIT"
    },
    "integrationData": {
      "externalClientId": "<External client ID>"
    }
  }
}'
JSON
{
  "lineId": "<UUID of the product ID>",
  "type": "CLIENT_VALIDATION_FAILED",
  "payload": {
    "referrer": "<Referrer URL>",
    "intake": {
      "<Employee count question ID>": {
        "type": "ANSWER",
        "answer": "55",
        "qid": "<Employee count question ID>"
      },
      "<Claims in the last two years question ID>": {
        "type": "ANSWER",
        "answer": "5",
        "qid": "<Claims in the last two years question ID>"
      }
    },
    "clientId": "<UUID of the client ID>",
    "quoteId": "<UUID of the quote request ID>",
    "policyId": "<UUID of the policy ID>",
    "documents": [],
    "intakeLoopIterationIdsToDelete": [],
    "metadata": {
      "validationFailureReason": "OFAC_HIT"
    },
    "integrationData": {
      "externalClientId": "<External client ID>"
    }
  }
}

Request Fields#

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

Payload Fields#

PropertyRequiredDescription
referrerNoOptional string value to track a referral.
intakeNoMap of question ID to answer object.
clientIdNoUUID of the client that failed validation.
quoteIdNoUUID of the quote.
policyIdNoUUID of the policy.
documentsNoList of documents related to the event.
intakeLoopIterationIdsToDeleteNoSet of intake loop iteration UUIDs to remove.
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.