---
title: "Retrieve a transaction batch"
method: GET
path: "/batch/transactions/{batchId}"
tags: ["batch"]
---

# Retrieve a transaction batch

`GET /batch/transactions/{batchId}`

## Request

- Base URL: `https://sandbox.api.flagright.com`
- URL: `https://sandbox.api.flagright.com/batch/transactions/{batchId}`
- Auth: API key in header `x-api-key`

## Path parameters

- `batchId` string, required

## Query parameters

- `pageSize` number, double
- `page` number, double

## Response `200`

OK

- BatchTransactionMonitoringResults
  - `transactions` BatchTransactionMonitoringResult[], required
    - `transactionId` string, required: Transaction ID that the results pertain to
    - `status` 'ALLOW' | 'FLAG' | 'BLOCK' | 'SUSPEND', required: Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst
    - `riskScoreDetails` TransactionRiskScoringResult
      - `trsScore` number, double: Transaction risk scoring score
      - `trsRiskLevel` 'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
      - `originUserCraRiskScore` number, double: Origin user's CRA risk score
      - `destinationUserCraRiskScore` number, double: Destination user's CRA risk score
      - `originUserCraRiskLevel` 'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
      - `destinationUserCraRiskLevel` 'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
      - `trsRiskFactors` RiskFactorBreakdown[]: Per-factor TRS breakdown; omitted unless the RISK_SCORE_BREAKDOWN feature is enabled
        - `riskFactorId` string
        - `riskFactorName` string
        - `riskFactorVersionId` string: Set for factor score detail rows
        - `value` string
        - `riskScore` number, double
        - `riskLevel` string
        - `weight` number, double
      - `originUserAvgTrsScore` number, double: Origin user's average TRS after this transaction; omitted unless the RISK_SCORE_BREAKDOWN feature is enabled
      - `destinationUserAvgTrsScore` number, double: Destination user's average TRS after this transaction; omitted unless the RISK_SCORE_BREAKDOWN feature is enabled
      - `krsWeight` number, double: KRS weight in the CRA formula when using custom weighting; omitted unless the RISK_SCORE_BREAKDOWN feature is enabled
      - `avgTrsWeight` number, double: Average TRS weight in the CRA formula when using custom weighting; omitted unless the RISK_SCORE_BREAKDOWN feature is enabled
    - `hitRules` HitRulesDetails[], required: Uniquue transaction identifier
      - `ruleId` string: Unique rule identifier
      - `ruleInstanceId` string, required
      - `ruleName` string, required: Name of the rule
      - `ruleDescription` string, required: Description of the rule
      - `versionId` string
      - `executedAt` number, double: Timestamp when the rule was hit
      - `executedRiskLevel` 'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
      - `ruleAction` 'ALLOW' | 'FLAG' | 'BLOCK' | 'SUSPEND', required: Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst
      - `ruleHitMeta` RuleHitMeta: Details of rule execution, for internal purposes only
        - `hitDirections` RuleHitDirection[]
        - `falsePositiveDetails` FalsePositiveDetails
          - `isFalsePositive` boolean, required
          - `confidenceScore` number, double, required
        - `sanctionsDetails` SanctionsDetails[]
          - `name` string, required
          - `searchId` string, required
          - `requestHash` string
          - `iban` string
          - `entityType` 'CONSUMER_NAME' | 'LEGAL_NAME' | 'SHAREHOLDER' | 'DIRECTOR' | 'NAME_ON_CARD' | 'PAYMENT_NAME' | 'PAYMENT_BENEFICIARY_NAME' | 'BANK_NAME' | 'BANK_BIC' | 'CORRESPONDENT_BANK_NAME' | 'BANK_ACCOUNT_HOLDER_NAME' | 'BUSINESS_PARTNER' | 'ASSOCIATED_PARTY' | 'CONSUMER_ALIAS' | 'LEGAL_ENTITY_ALIAS' | 'TRANSACTION_REFERENCE' | 'TRANSACTION_TAG' | 'CONSUMER_ADDRESS' | 'LEGAL_ENTITY_ADDRESS' | 'DIRECTOR_ADDRESS' | 'SHAREHOLDER_ADDRESS' | 'BUSINESS_PARTNER_ADDRESS' | 'ASSOCIATED_PARTY_ADDRESS' | 'BANK_ADDRESS' | 'CORRESPONDENT_BANK_ADDRESS' | 'PAYMENT_DETAILS_ADDRESS'
          - `sanctionHitIds` string[]
          - `hitContext` SanctionsHitContext
            - `entity` 'USER' | 'BANK' | 'IBAN' | 'EXTERNAL_USER', required
            - `entityType` 'CONSUMER_NAME' | 'LEGAL_NAME' | 'SHAREHOLDER' | 'DIRECTOR' | 'NAME_ON_CARD' | 'PAYMENT_NAME' | 'PAYMENT_BENEFICIARY_NAME' | 'BANK_NAME' | 'BANK_BIC' | 'CORRESPONDENT_BANK_NAME' | 'BANK_ACCOUNT_HOLDER_NAME' | 'BUSINESS_PARTNER' | 'ASSOCIATED_PARTY' | 'CONSUMER_ALIAS' | 'LEGAL_ENTITY_ALIAS' | 'TRANSACTION_REFERENCE' | 'TRANSACTION_TAG' | 'CONSUMER_ADDRESS' | 'LEGAL_ENTITY_ADDRESS' | 'DIRECTOR_ADDRESS' | 'SHAREHOLDER_ADDRESS' | 'BUSINESS_PARTNER_ADDRESS' | 'ASSOCIATED_PARTY_ADDRESS' | 'BANK_ADDRESS' | 'CORRESPONDENT_BANK_ADDRESS' | 'PAYMENT_DETAILS_ADDRESS'
            - `userId` string
            - `transactionId` string
            - `ruleInstanceId` string
            - `ruleId` string
            - `iban` string
            - `yearOfBirth` integer
            - `searchTerm` string
            - `paymentMethodId` string
          - `hitDirection` 'ORIGIN' | 'DESTINATION'
          - `isRuleHit` boolean
        - `isOngoingScreeningHit` boolean
      - `labels` RuleLabels[]
      - `nature` 'AML' | 'FRAUD' | 'CTF' | 'SCREENING'
      - `isShadow` boolean
  - `totalCount` number, double, required

## Other responses

- `401`: Unauthorized
- `404`: NotFound
- `429`: Too Many Requests

---

[API](https://skmtc.dev/flagright/apis/flagright-2.md) - [All operations](https://skmtc.dev/flagright/apis/flagright-2/llms.txt) - [OpenAPI document](https://skmtc.dev/flagright/apis/flagright-2/revisions/1c04818a93a7?raw)