Get a customer scenario execution data for one scenario execution.

GET 
/customers/:customerId/scenario-executions/:executionId

Get a single customer's scenario execution data.

Request

Path Parameters

executionId uuidrequired
customerId uuidrequired

Responses

200

Successful response

application/json

Schema

Schema

execution_id stringrequired
session_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: [PrivacyPreservingMonitoring, IndividualMonitoring, TransactionMonitoring, TFHE, OffChainZKP, ChallengeQuery]
result object
anyOf
MOD1
result objectrequired
is_valid booleanrequired
reasons string[]required
data object
anyOf
MOD2
ID3 objectnullable
id stringrequired
@context string[]
type string[]required
expirationDate string
issuanceDate string
credentialSubject objectrequired
credentialStatus objectrequired
id stringrequired
type stringrequired
Possible values: [SparseMerkleTreeProof, Iden3ReverseSparseMerkleTreeProof, Iden3commRevocationStatusV1.0, Iden3OnchainSparseMerkleTreeProof2023]
revocationNonce number
issuer stringrequired
credentialSchema objectrequired
id stringrequired
type stringrequired
proof
AMLScreeningsResults objectnullable
id stringrequired
@context string[]
type string[]required
expirationDate string
issuanceDate string
credentialSubject objectrequired
credentialStatus objectrequired
id stringrequired
type stringrequired
Possible values: [SparseMerkleTreeProof, Iden3ReverseSparseMerkleTreeProof, Iden3commRevocationStatusV1.0, Iden3OnchainSparseMerkleTreeProof2023]
revocationNonce number
issuer stringrequired
credentialSchema objectrequired
id stringrequired
type stringrequired
proof
IDScan objectnullable
id stringrequired
@context string[]
type string[]required
expirationDate string
issuanceDate string
credentialSubject objectrequired
credentialStatus objectrequired
id stringrequired
type stringrequired
Possible values: [SparseMerkleTreeProof, Iden3ReverseSparseMerkleTreeProof, Iden3commRevocationStatusV1.0, Iden3OnchainSparseMerkleTreeProof2023]
revocationNonce number
issuer stringrequired
credentialSchema objectrequired
id stringrequired
type stringrequired
proof
IDInformation objectnullable
id stringrequired
@context string[]
type string[]required
expirationDate string
issuanceDate string
credentialSubject objectrequired
credentialStatus objectrequired
id stringrequired
type stringrequired
Possible values: [SparseMerkleTreeProof, Iden3ReverseSparseMerkleTreeProof, Iden3commRevocationStatusV1.0, Iden3OnchainSparseMerkleTreeProof2023]
revocationNonce number
issuer stringrequired
credentialSchema objectrequired
id stringrequired
type stringrequired
proof
IDScanSelfie objectnullable
id stringrequired
@context string[]
type string[]required
expirationDate string
issuanceDate string
credentialSubject objectrequired
credentialStatus objectrequired
id stringrequired
type stringrequired
Possible values: [SparseMerkleTreeProof, Iden3ReverseSparseMerkleTreeProof, Iden3commRevocationStatusV1.0, Iden3OnchainSparseMerkleTreeProof2023]
revocationNonce number
issuer stringrequired
credentialSchema objectrequired
id stringrequired
type stringrequired
proof
SelfieImage objectnullable
id stringrequired
@context string[]
type string[]required
expirationDate string
issuanceDate string
credentialSubject objectrequired
credentialStatus objectrequired
id stringrequired
type stringrequired
Possible values: [SparseMerkleTreeProof, Iden3ReverseSparseMerkleTreeProof, Iden3commRevocationStatusV1.0, Iden3OnchainSparseMerkleTreeProof2023]
revocationNonce number
issuer stringrequired
credentialSchema objectrequired
id stringrequired
type stringrequired
proof
IDScanPassport objectnullable
id stringrequired
@context string[]
type string[]required
expirationDate string
issuanceDate string
credentialSubject objectrequired
credentialStatus objectrequired
id stringrequired
type stringrequired
Possible values: [SparseMerkleTreeProof, Iden3ReverseSparseMerkleTreeProof, Iden3commRevocationStatusV1.0, Iden3OnchainSparseMerkleTreeProof2023]
revocationNonce number
issuer stringrequired
credentialSchema objectrequired
id stringrequired
type stringrequired
proof
IDImage objectnullable
id stringrequired
@context string[]
type string[]required
expirationDate string
issuanceDate string
credentialSubject objectrequired
credentialStatus objectrequired
id stringrequired
type stringrequired
Possible values: [SparseMerkleTreeProof, Iden3ReverseSparseMerkleTreeProof, Iden3commRevocationStatusV1.0, Iden3OnchainSparseMerkleTreeProof2023]
revocationNonce number
issuer stringrequired
credentialSchema objectrequired
id stringrequired
type stringrequired
proof
ProofOfResidence objectnullable
id stringrequired
@context string[]
type string[]required
expirationDate string
issuanceDate string
credentialSubject objectrequired
credentialStatus objectrequired
id stringrequired
type stringrequired
Possible values: [SparseMerkleTreeProof, Iden3ReverseSparseMerkleTreeProof, Iden3commRevocationStatusV1.0, Iden3OnchainSparseMerkleTreeProof2023]
revocationNonce number
issuer stringrequired
credentialSchema objectrequired
id stringrequired
type stringrequired
proof
rule_data objectnullable
queryId
Unique ID for the query
id
Unique ID for the query
requestId numbernullable
Request ID for ZKPs
attribute object required
anyOf
MOD1
string
MOD2
version stringrequired
Possible values: [v1]
schema stringrequired
Possible values: [Customer, KycSession, Transaction, Tfhe]
path stringrequired
Possible values: [Customer, Customer/identityData, Customer/identityData/age, Customer/identityData/nationality, Customer/identityData/residence, Customer/identityData/email, Customer/identityData/phone, Customer/kycStatus, Customer/kycStatus/allCheckStatus, Customer/kycStatus/selfieCheckStatus, Customer/kycStatus/idImageCheckStatus, Customer/kycStatus/idInformationCheckStatus, Customer/kycStatus/proofOfResidenceCheckStatus, Customer/amlScreening, Customer/amlScreening/amlHits, Customer/amlScreening/pepHits, Customer/amlScreening/sanctionsHits, Customer/amlScreening/adverseMediaHits, Customer/amlScreening/pepAttribute, Customer/amlScreening/sanctionsStatus, Customer/amlScreening/adverseMediaStatus, Customer/duplicates, Customer/duplicates/duplicateHits, Customer/duplicates/hasDuplicates, Customer/walletScreening, Customer/walletScreening/riskScore, Customer/fraudAnalytics, Customer/fraudAnalytics/ipCountry, Customer/fraudAnalytics/ipVpn, Customer/fraudAnalytics/ipScore, Customer/fraudAnalytics/emailScore, Customer/fraudAnalytics/phoneScore, KycSession, KycSession/vcs, KycSession/vcs/IDInformation, KycSession/vcs/IDInformation/v1, KycSession/vcs/IDInformation/v1/id, KycSession/vcs/IDInformation/v1/@context, KycSession/vcs/IDInformation/v1/type, KycSession/vcs/IDInformation/v1/expirationDate, KycSession/vcs/IDInformation/v1/issuanceDate, KycSession/vcs/IDInformation/v1/credentialSubject, KycSession/vcs/IDInformation/v1/credentialSubject/id, KycSession/vcs/IDInformation/v1/credentialSubject/journeyId, KycSession/vcs/IDInformation/v1/credentialSubject/reviewAnswer, KycSession/vcs/IDInformation/v1/credentialSubject/reviewRejectType, KycSession/vcs/IDInformation/v1/credentialSubject/reviewRejectLabels, KycSession/vcs/IDInformation/v1/credentialSubject/documentType, KycSession/vcs/IDInformation/v1/credentialSubject/entryDate, KycSession/vcs/IDInformation/v1/credentialSubject/entryTime, KycSession/vcs/IDInformation/v1/credentialSubject/personalData, KycSession/vcs/IDInformation/v1/credentialSubject/personalData/firstName, KycSession/vcs/IDInformation/v1/credentialSubject/personalData/middleName, KycSession/vcs/IDInformation/v1/credentialSubject/personalData/lastName, KycSession/vcs/IDInformation/v1/credentialSubject/personalData/gender, KycSession/vcs/IDInformation/v1/credentialSubject/personalData/age, KycSession/vcs/IDInformation/v1/credentialSubject/personalData/citizenship, KycSession/vcs/IDInformation/v1/credentialSubject/personalData/country, KycSession/vcs/IDInformation/v1/credentialSubject/personalData/fullName, KycSession/vcs/IDInformation/v1/credentialSubject/personalData/birthDate, KycSession/vcs/IDInformation/v1/credentialSubject/personalData/countryOfBirth, KycSession/vcs/IDInformation/v1/credentialSubject/personalData/stateOfBirth, KycSession/vcs/IDInformation/v1/credentialSubject/isSandbox, KycSession/vcs/IDInformation/v1/credentialStatus, KycSession/vcs/IDInformation/v1/credentialStatus/id, KycSession/vcs/IDInformation/v1/credentialStatus/type, KycSession/vcs/IDInformation/v1/credentialStatus/revocationNonce, KycSession/vcs/IDInformation/v1/issuer, KycSession/vcs/IDInformation/v1/credentialSchema, KycSession/vcs/IDInformation/v1/credentialSchema/id, KycSession/vcs/IDInformation/v1/credentialSchema/type, KycSession/vcs/IDInformation/v1/proof, KycSession/vcs/IDImage, KycSession/vcs/IDImage/v1, KycSession/vcs/IDImage/v1/id, KycSession/vcs/IDImage/v1/@context, KycSession/vcs/IDImage/v1/type, KycSession/vcs/IDImage/v1/expirationDate, KycSession/vcs/IDImage/v1/issuanceDate, KycSession/vcs/IDImage/v1/credentialSubject, KycSession/vcs/IDImage/v1/credentialSubject/id, KycSession/vcs/IDImage/v1/credentialSubject/journeyId, KycSession/vcs/IDImage/v1/credentialSubject/base64_front, KycSession/vcs/IDImage/v1/credentialSubject/base64_back, KycSession/vcs/IDImage/v1/credentialSubject/name, KycSession/vcs/IDImage/v1/credentialSubject/documentType, KycSession/vcs/IDImage/v1/credentialSubject/entryDate, KycSession/vcs/IDImage/v1/credentialSubject/entryTime, KycSession/vcs/IDImage/v1/credentialSubject/mediaType_front, KycSession/vcs/IDImage/v1/credentialSubject/mediaType_back, KycSession/vcs/IDImage/v1/credentialSubject/reviewAnswer, KycSession/vcs/IDImage/v1/credentialSubject/reviewRejectType, KycSession/vcs/IDImage/v1/credentialSubject/reviewRejectLabels, KycSession/vcs/IDImage/v1/credentialSubject/isSandbox, KycSession/vcs/IDImage/v1/credentialStatus, KycSession/vcs/IDImage/v1/credentialStatus/id, KycSession/vcs/IDImage/v1/credentialStatus/type, KycSession/vcs/IDImage/v1/credentialStatus/revocationNonce, KycSession/vcs/IDImage/v1/issuer, KycSession/vcs/IDImage/v1/credentialSchema, KycSession/vcs/IDImage/v1/credentialSchema/id, KycSession/vcs/IDImage/v1/credentialSchema/type, KycSession/vcs/IDImage/v1/proof, KycSession/vcs/SelfieImage, KycSession/vcs/SelfieImage/v1, KycSession/vcs/SelfieImage/v1/id, KycSession/vcs/SelfieImage/v1/@context, KycSession/vcs/SelfieImage/v1/type, KycSession/vcs/SelfieImage/v1/expirationDate, KycSession/vcs/SelfieImage/v1/issuanceDate, KycSession/vcs/SelfieImage/v1/credentialSubject, KycSession/vcs/SelfieImage/v1/credentialSubject/id, KycSession/vcs/SelfieImage/v1/credentialSubject/journeyId, KycSession/vcs/SelfieImage/v1/credentialSubject/base64, KycSession/vcs/SelfieImage/v1/credentialSubject/name, KycSession/vcs/SelfieImage/v1/credentialSubject/mediaType, KycSession/vcs/SelfieImage/v1/credentialSubject/entryDate, KycSession/vcs/SelfieImage/v1/credentialSubject/entryTime, KycSession/vcs/SelfieImage/v1/credentialSubject/reviewAnswer, KycSession/vcs/SelfieImage/v1/credentialSubject/reviewRejectType, KycSession/vcs/SelfieImage/v1/credentialSubject/reviewRejectLabels, KycSession/vcs/SelfieImage/v1/credentialSubject/isSandbox, KycSession/vcs/SelfieImage/v1/credentialStatus, KycSession/vcs/SelfieImage/v1/credentialStatus/id, KycSession/vcs/SelfieImage/v1/credentialStatus/type, KycSession/vcs/SelfieImage/v1/credentialStatus/revocationNonce, KycSession/vcs/SelfieImage/v1/issuer, KycSession/vcs/SelfieImage/v1/credentialSchema, KycSession/vcs/SelfieImage/v1/credentialSchema/id, KycSession/vcs/SelfieImage/v1/credentialSchema/type, KycSession/vcs/SelfieImage/v1/proof, KycSession/vcs/ProofOfResidence, KycSession/vcs/ProofOfResidence/v1, KycSession/vcs/ProofOfResidence/v1/id, KycSession/vcs/ProofOfResidence/v1/@context, KycSession/vcs/ProofOfResidence/v1/type, KycSession/vcs/ProofOfResidence/v1/expirationDate, KycSession/vcs/ProofOfResidence/v1/issuanceDate, KycSession/vcs/ProofOfResidence/v1/credentialSubject, KycSession/vcs/ProofOfResidence/v1/credentialSubject/id, KycSession/vcs/ProofOfResidence/v1/credentialSubject/journeyId, KycSession/vcs/ProofOfResidence/v1/credentialSubject/country, KycSession/vcs/ProofOfResidence/v1/credentialSubject/base64, KycSession/vcs/ProofOfResidence/v1/credentialSubject/name, KycSession/vcs/ProofOfResidence/v1/credentialSubject/documentType, KycSession/vcs/ProofOfResidence/v1/credentialSubject/entryDate, KycSession/vcs/ProofOfResidence/v1/credentialSubject/entryTime, KycSession/vcs/ProofOfResidence/v1/credentialSubject/mediaType, KycSession/vcs/ProofOfResidence/v1/credentialSubject/county, KycSession/vcs/ProofOfResidence/v1/credentialSubject/city, KycSession/vcs/ProofOfResidence/v1/credentialSubject/streetName, KycSession/vcs/ProofOfResidence/v1/credentialSubject/postalCode, KycSession/vcs/ProofOfResidence/v1/credentialSubject/isSandbox, KycSession/vcs/ProofOfResidence/v1/credentialStatus, KycSession/vcs/ProofOfResidence/v1/credentialStatus/id, KycSession/vcs/ProofOfResidence/v1/credentialStatus/type, KycSession/vcs/ProofOfResidence/v1/credentialStatus/revocationNonce, KycSession/vcs/ProofOfResidence/v1/issuer, KycSession/vcs/ProofOfResidence/v1/credentialSchema, KycSession/vcs/ProofOfResidence/v1/credentialSchema/id, KycSession/vcs/ProofOfResidence/v1/credentialSchema/type, KycSession/vcs/ProofOfResidence/v1/proof, Transaction, Transaction/amount, Transaction/amount/USD, Transaction/amount/EUR, Transaction/amount/GBP, Transaction/event, Transaction/event/transactionDate, Transaction/event/amount, Transaction/event/riskScore, Transaction/event/riskLevel, Transaction/event/type, Transaction/event/assets, Transaction/originator, Transaction/originator/countryOfResidence, Transaction/originator/nationality, Transaction/originator/riskScore, Transaction/originator/riskLevel, Transaction/originator/type, Transaction/originator/address, Transaction/beneficiary, Transaction/beneficiary/countryOfResidence, Transaction/beneficiary/nationality, Transaction/beneficiary/riskScore, Transaction/beneficiary/riskLevel, Transaction/beneficiary/type, Transaction/beneficiary/address, Transaction/transactionStats, Transaction/transactionStats/last1D, Transaction/transactionStats/last1D/count, Transaction/transactionStats/last1D/totalAmountUsd, Transaction/transactionStats/last1D/maxAmountUsd, Transaction/transactionStats/last7D, Transaction/transactionStats/last7D/count, Transaction/transactionStats/last7D/totalAmountUsd, Transaction/transactionStats/last7D/maxAmountUsd, Transaction/transactionStats/last14D, Transaction/transactionStats/last14D/count, Transaction/transactionStats/last14D/totalAmountUsd, Transaction/transactionStats/last14D/maxAmountUsd, Transaction/transactionStats/last30D, Transaction/transactionStats/last30D/count, Transaction/transactionStats/last30D/totalAmountUsd, Transaction/transactionStats/last30D/maxAmountUsd, Transaction/transactionStats/yearToDate, Transaction/transactionStats/yearToDate/count, Transaction/transactionStats/yearToDate/totalAmountUsd, Transaction/transactionStats/yearToDate/maxAmountUsd, Transaction/transactionStats/monthToDate, Transaction/transactionStats/monthToDate/count, Transaction/transactionStats/monthToDate/totalAmountUsd, Transaction/transactionStats/monthToDate/maxAmountUsd, Tfhe, Tfhe/vcs, Tfhe/vcs/IDInformationTfhe, Tfhe/vcs/IDInformationTfhe/v1, Tfhe/vcs/IDInformationTfhe/v1/id, Tfhe/vcs/IDInformationTfhe/v1/@context, Tfhe/vcs/IDInformationTfhe/v1/type, Tfhe/vcs/IDInformationTfhe/v1/expirationDate, Tfhe/vcs/IDInformationTfhe/v1/issuanceDate, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/id, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/journeyId, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/reviewAnswer, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/reviewRejectType, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/reviewRejectLabels, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/documentType, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/entryDate, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/entryTime, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData/firstName, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData/middleName, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData/lastName, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData/gender, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData/age, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData/citizenship, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData/country, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData/fullName, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData/birthDate, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData/countryOfBirth, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/personalData/stateOfBirth, Tfhe/vcs/IDInformationTfhe/v1/credentialSubject/isSandbox, Tfhe/vcs/IDInformationTfhe/v1/credentialStatus, Tfhe/vcs/IDInformationTfhe/v1/credentialStatus/id, Tfhe/vcs/IDInformationTfhe/v1/credentialStatus/type, Tfhe/vcs/IDInformationTfhe/v1/credentialStatus/revocationNonce, Tfhe/vcs/IDInformationTfhe/v1/issuer, Tfhe/vcs/IDInformationTfhe/v1/credentialSchema, Tfhe/vcs/IDInformationTfhe/v1/credentialSchema/id, Tfhe/vcs/IDInformationTfhe/v1/credentialSchema/type, Tfhe/vcs/IDInformationTfhe/v1/proof]
value object nullable
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, $exists]
type stringnullable
Possible values: [IDInformation, IDInformationTfhe, SelfieImage, IDImage, ProofOfResidence, AMLScreeningsResults, ID3, IDScan, IDScanSelfie, IDScanPassport]
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",
  "session_id": "string",
  "scenario_executions": [
    {
      "scenarioId": "string",
      "rules": [
        {
          "id": "string",
          "execution_id": "string",
          "cms_object_id": "string",
          "cms_scenario_id": "string",
          "object_type": "PrivacyPreservingMonitoring",
          "result": {},
          "rule_data": {
            "requestId": 0,
            "attribute": "string",
            "value": true,
            "operator": "$noop",
            "type": "IDInformation"
          },
          "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...