Retrieve a Consumer User Event | Flagright

curl https://sandbox.api.flagright.com/events/consumer/user/eventId \
     -H "x-api-key: <apiKey>"

{
  "timestamp": 2220000000000,
  "userId": "string",
  "eventId": "string",
  "reason": "string",
  "eventDescription": "string",
  "updatedConsumerUserAttributes": {
    "userDetails": {
      "name": {
        "firstName": "Baran",
        "middleName": "Realblood",
        "lastName": "Ozkan"
      },
      "dateOfBirth": "1991-01-01",
      "countryOfResidence": "US",
      "countryOfNationality": "DE"
    },
    "legalDocuments": [
      {
        "documentType": "passport",
        "documentNumber": "Z9431P",
        "documentIssuedDate": 1639939034000,
        "documentExpirationDate": 1839939034000,
        "documentIssuedCountry": "DE",
        "tags": [
          {
            "key": "customerType",
            "value": "wallet"
          }
        ]
      }
    ],
    "contactDetails": {
      "emailIds": [
        "baran@flagright.com"
      ],
      "contactNumbers": [
        "+37112345432"
      ],
      "websites": [
        "flagright.com"
      ],
      "addresses": [
        {
          "addressLines": [
            "Klara-Franke Str 20"
          ],
          "postcode": "10557",
          "city": "Berlin",
          "state": "Berlin",
          "country": "Germany",
          "tags": [
            {
              "key": "customKey",
              "value": "customValue"
            }
          ]
        }
      ]
    },
    "tags": [
      {
        "key": "customKey",
        "value": "customValue"
      }
    ],
    "metaData": {
      "batteryLevel": 76.3,
      "deviceLatitude": 13.009711,
      "deviceLongitude": 76.102898,
      "ipAddress": "79.144.2.20",
      "vpnUsed": true
    },
    "createdTimestamp": 1641654664000,
    "userId": "96647cfd9e8fe66ee0f3362e011e34e8"
  },
  "externalLinks": [
    "string"
  ],
  "executedRules": [
    {
      "ruleInstanceId": "string",
      "ruleName": "string",
      "ruleDescription": "string",
      "ruleAction": "ALLOW",
      "ruleHit": true,
      "ruleId": "string",
      "versionId": "string",
      "executedAt": 2220000000000,
      "ruleHitMeta": {
        "hitDirections": [
          "ORIGIN"
        ],
        "falsePositiveDetails": {
          "isFalsePositive": true,
          "confidenceScore": 1.1
        },
        "sanctionsDetails": [
          {
            "name": "string",
            "searchId": "string",
            "iban": "string",
            "entityType": "CONSUMER_NAME",
            "sanctionHitIds": [
              "string"
            ],
            "hitContext": {
              "entity": "USER",
              "entityType": "CONSUMER_NAME",
              "userId": "string",
              "transactionId": "string",
              "ruleInstanceId": "string",
              "ruleId": "string",
              "iban": "string",
              "yearOfBirth": 1,
              "searchTerm": "string",
              "paymentMethodId": "string"
            },
            "hitDirection": "ORIGIN",
            "isRuleHit": true
          }
        ],
        "isOngoingScreeningHit": true
      },
      "vars": [
        {
          "value": {},
          "direction": "ORIGIN"
        }
      ],
      "labels": [
        "UNEXPECTED_BEHAVIOR"
      ],
      "nature": "AML",
      "isShadow": true
    }
  ],
  "hitRules": [
    {
      "ruleInstanceId": "string",
      "ruleName": "string",
      "ruleDescription": "string",
      "ruleAction": "ALLOW",
      "ruleId": "string",
      "versionId": "string",
      "executedAt": 2220000000000,
      "ruleHitMeta": {
        "hitDirections": [
          "ORIGIN"
        ],
        "falsePositiveDetails": {
          "isFalsePositive": true,
          "confidenceScore": 1.1
        },
        "sanctionsDetails": [
          {
            "name": "string",
            "searchId": "string",
            "iban": "string",
            "entityType": "CONSUMER_NAME",
            "sanctionHitIds": [
              "string"
            ],
            "hitContext": {
              "entity": "USER",
              "entityType": "CONSUMER_NAME",
              "userId": "string",
              "transactionId": "string",
              "ruleInstanceId": "string",
              "ruleId": "string",
              "iban": "string",
              "yearOfBirth": 1,
              "searchTerm": "string",
              "paymentMethodId": "string"
            },
            "hitDirection": "ORIGIN",
            "isRuleHit": true
          }
        ],
        "isOngoingScreeningHit": true
      },
      "labels": [
        "UNEXPECTED_BEHAVIOR"
      ],
      "nature": "AML",
      "isShadow": true
    }
  ],
  "riskScoreDetails": {
    "kycRiskScore": 1.1,
    "craRiskScore": 1.1,
    "kycRiskLevel": "VERY_HIGH",
    "craRiskLevel": "VERY_HIGH"
  }
}

GET a Consumer User Event

You can retrieve any consumer user event you created using the POST Consumer User Events call.

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Path parameters

eventIdstringRequired

Unique Consumer User Event Identifier

Response

timestampdouble315529200000-4133890801000

Timestamp of the event

userIdstring>=1 character

Transaction ID the event pertains to

eventIdstring

Unique event ID

reasonstring

Reason for the event or a state change

eventDescriptionstring

Event description

updatedConsumerUserAttributesobject

Model for User details

externalLinkslist of strings

External links related to the consumer user

executedRuleslist of objects

hitRuleslist of objects

riskScoreDetailsobject

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error