Retrieve a transaction batch

GET

/batch/transactions/:batchId

GET

/batch/transactions/:batchId

1 from flagright import Flagright
2 
3 client = Flagright(
4     api_key="YOUR_API_KEY",
5 )
6 client.batch.get_transactions(
7     batch_id="batchId",
8     page_size=1.1,
9     page=1.1,
10 )

Try it

200Retrieved

1 {
2   "transactions": [
3     {
4       "transactionId": "string",
5       "status": "ALLOW",
6       "hitRules": [
7         {
8           "ruleInstanceId": "string",
9           "ruleName": "string",
10           "ruleDescription": "string",
11           "ruleAction": "ALLOW",
12           "ruleId": "string",
13           "versionId": "string",
14           "executedAt": 2220000000000,
15           "ruleHitMeta": {
16             "hitDirections": [
17               "ORIGIN"
18             ],
19             "falsePositiveDetails": {
20               "isFalsePositive": true,
21               "confidenceScore": 1.1
22             },
23             "sanctionsDetails": [
24               {
25                 "name": "string",
26                 "searchId": "string",
27                 "iban": "string",
28                 "entityType": "CONSUMER_NAME",
29                 "sanctionHitIds": [
30                   "string"
31                 ],
32                 "hitContext": {
33                   "entity": "USER",
34                   "entityType": "CONSUMER_NAME",
35                   "userId": "string",
36                   "transactionId": "string",
37                   "ruleInstanceId": "string",
38                   "ruleId": "string",
39                   "iban": "string",
40                   "yearOfBirth": 1.1,
41                   "searchTerm": "string",
42                   "paymentMethodId": "string"
43                 },
44                 "hitDirection": "ORIGIN",
45                 "isRuleHit": true
46               }
47             ],
48             "isOngoingScreeningHit": true
49           },
50           "labels": [
51             "UNEXPECTED_BEHAVIOR"
52           ],
53           "nature": "AML",
54           "isShadow": true
55         }
56       ],
57       "riskScoreDetails": {
58         "trsScore": 1.1,
59         "trsRiskLevel": "VERY_HIGH",
60         "originUserCraRiskScore": 1.1,
61         "destinationUserCraRiskScore": 1.1,
62         "originUserCraRiskLevel": "VERY_HIGH",
63         "destinationUserCraRiskLevel": "VERY_HIGH"
64       }
65     }
66   ],
67   "totalCount": 1.1
68 }

Authentication

x-api-keystring

API Key authentication via header

Path parameters

batchIdstringRequired

Unique Batch Identifier

Query parameters

pageSizedoubleOptional1-100

Page size (default 20)

pagedoubleOptional>=1

Page

Response

transactionslist of objects

totalCountdouble

Authentication

Path parameters

Query parameters

Response

Errors