Get customer scenario executions

GET 
/customers/:customerId/scenario-executions

Get a single customer's scenario execution history using filters.

Request

Path Parameters

customerId stringrequired

Query Parameters

currentPage any
limit any
fromDate date-time
toDate date-time

Responses

200

Successful response

application/json

Schema

Schema

• Array [
execution_id stringrequired
scenario_executions object[]required
Array [
scenarioId stringrequired
rules object[]required
Array [
id stringrequired
execution_id stringrequired
cms_object_id stringrequired
cms_scenario_id stringnullable
object_type stringrequired
Possible values: [ChallengeQuery, OnChainZKP, OffChainZKP, IndividualCustomerMonitoring, TransactionMonitoring]
result object
anyOf
MOD1
result objectrequired
is_valid booleanrequired
reasons string[]required
rule_data objectnullable
type stringrequired
Possible values: [IDInformation, SelfieImage, IDImage, ProofOfResidence, AMLScreeningsResults, ID3, IDScan, IDScanSelfie, IDScanPassport]
requestId numbernullable
Request ID for ZKPs
attribute stringrequired
value object required
anyOf
MOD1
boolean
MOD2
string
MOD3
number
MOD4
Array [
string
]
MOD5
Array [
number
]
operator stringrequired
Possible values: [$noop, $eq, $lt, $lte, $gt, $gte, $in, $nin, $ne]
status stringnullable
Possible values: [valid, not-valid, error, unknown]
executed_at date-timerequired
created_at date-timerequired
documents object[]nullable
Array [
documentType stringrequired
Possible values: [proof_of_residence, id_image_front, id_image_back, selfie_image]
url urirequired
]
]
scenarioStatus stringrequired
Possible values: [valid, not-valid, error, unknown]
executed_at date-timerequired
]
execution_status stringrequired

Possible values: [valid, not-valid, error, unknown]

last_execution_date date-timerequired
• ]

Example (from schema)

[
  {
    "execution_id": "string",
    "scenario_executions": [
      {
        "scenarioId": "string",
        "rules": [
          {
            "id": "string",
            "execution_id": "string",
            "cms_object_id": "string",
            "cms_scenario_id": "string",
            "object_type": "ChallengeQuery",
            "result": {},
            "rule_data": {
              "type": "IDInformation",
              "requestId": 0,
              "attribute": "string",
              "value": true,
              "operator": "$noop"
            },
            "status": "valid",
            "executed_at": "2024-07-29T15:51:28.071Z",
            "created_at": "2024-07-29T15:51:28.071Z",
            "documents": [
              {
                "documentType": "proof_of_residence",
                "url": "string"
              }
            ]
          }
        ],
        "scenarioStatus": "valid",
        "executed_at": "2024-07-29T15:51:28.071Z"
      }
    ],
    "execution_status": "valid",
    "last_execution_date": "2024-07-29T15:51:28.071Z"
  }
]

default

Error response

application/json

Schema

Schema

message stringrequired
code stringrequired
issues object[]
Array [
message stringrequired
]

Example (from schema)

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Loading...