Retrieve a transaction batch | Flagright

curl https://sandbox.api.flagright.com/batch/transactions/batchId \
     -H "x-api-key: <apiKey>"

{
  "transactions": [
    {
      "transactionId": "string",
      "status": "ALLOW",
      "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": {
        "trsScore": 1.1,
        "trsRiskLevel": "VERY_HIGH",
        "originUserCraRiskScore": 1.1,
        "destinationUserCraRiskScore": 1.1,
        "originUserCraRiskLevel": "VERY_HIGH",
        "destinationUserCraRiskLevel": "VERY_HIGH"
      }
    }
  ],
  "totalCount": 1.1
}

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Path parameters

batchIdstringRequired

Unique Batch Identifier

Query parameters

pageSizedoubleOptional1-100

Page size (default 20)

pagedoubleOptional>=1

Page

Response

transactionslist of objects

totalCountdouble

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error