CLIENT_VALIDATION

This event is fired when a customer's identity is being checked for compliance issues.

When and what fires this event?

If this event is defined on a product, and it has actions that are enabled:

API: can fire this event externally on demand.

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 '{
    "lineId": "<UUID of the product>",
    "type": "CLIENT_VALIDATION",
    "payload": {
        "referrer": "<referrer>",
        "intake": {
            "<qid>": {
                "type": "ANSWER",
                "answer": "<answer>",
                "qid": "<qid>"
              }
        },
        "clientId": "<clientId>"
    }
}'

{
    "lineId": "262e67be-c08c-43c0-bb51-06fe4408b4e9",
    "type": "CLIENT_VALIDATION",
    "payload": {
        "referrer": "referrer",
        "intake": {
          "numEmployees": {
            "type": "ANSWER",
            "answer": "55",
            "qid": "numEmployees"
          },
          "claimsLast2Yrs": {
            "type": "ANSWER",
            "answer": "2",
            "qid": "claimsLast2Yrs"
          }
        },
        "clientId": "3107a2fc-9a63-4e14-9a83-e4c325f4242b"
    }
}

Request fields

Property	Required	Description
`lineId`	`true`	UUID for the product to validate this client against
`type`	`true`	Must be set to `CLIENT_VALIDATION`
`payload`	`true`	Explained below

Payload fields

Property	Required	Description
`referrer`	`false`	Optional String value to track a referral
`intake`	`true`	Map of QID to answer
`clientId`	`true`	UUID for the client you wish to validate

Response json

{
    "triggerRequestId": "3282bbc7-8113-419c-b53d-9c84c150f3c4",
    "executedActionCount": 3,
    "expectedResponseCount": 0,
    "metadata": {
        "OFAC": {
            "OFACCheckPassed": true
        },
        "OFAC_BRIDGER": {
            "OFACCheckPassed": true
        },
        "MVR": {
            "MVRCheckPassed": true,
            "totalViolationCount": 0
        }
    }
}

Response fields

Property	Required	Description
`triggerRequestId`	`true`	UUID that identifies the execution of the trigger.
`executedActionCount`	`true`	Number of workflow actions executed by this trigger. A value of `0` means no actions were run.
`expectedResponseCount`	`true`	Number of responses expected from the executed actions. Here it is `0`, meaning no return data was expected.
`metadata`	`true`	Contains action-generated metadata. In this response, it is an empty object (`{}`).