Retrieve a Consumer User Event

GET

/events/consumer/user/:eventId

GET

/events/consumer/user/:eventId

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

Try it

200Retrieved

1 {
2   "timestamp": 1.1,
3   "userId": "userId",
4   "eventId": "eventId",
5   "reason": "reason",
6   "eventDescription": "eventDescription",
7   "updatedConsumerUserAttributes": {
8     "activatedTimestamp": 1.1,
9     "userDetails": {
10       "name": {
11         "firstName": "Baran",
12         "middleName": "Realblood",
13         "lastName": "Ozkan"
14       },
15       "dateOfBirth": "1991-01-01",
16       "userCategory": "userCategory",
17       "countryOfResidence": "US",
18       "countryOfTaxResidence": "AF",
19       "countryOfNationality": "DE",
20       "gender": "M",
21       "maritalStatus": "DIVORCED",
22       "placeOfBirth": {
23         "country": "AF"
24       },
25       "alias": [
26         "alias"
27       ]
28     },
29     "userStateDetails": {
30       "state": "UNACCEPTABLE",
31       "reason": "reason"
32     },
33     "kycStatusDetails": {
34       "reason": "reason",
35       "status": "SUCCESSFUL"
36     },
37     "eoddDate": 1.1,
38     "employmentStatus": "UNEMPLOYED",
39     "occupation": "occupation",
40     "legalDocuments": [
41       {
42         "documentType": "passport",
43         "documentNumber": "Z9431P",
44         "documentIssuedCountry": "DE",
45         "documentIssuedDate": 1639939034000,
46         "documentExpirationDate": 1839939034000,
47         "tags": [
48           {
49             "key": "customerType",
50             "value": "wallet"
51           }
52         ],
53         "nameOnDocument": {
54           "firstName": "Baran",
55           "middleName": "Realblood",
56           "lastName": "Ozkan"
57         }
58       }
59     ],
60     "contactDetails": {
61       "emailIds": [
62         "baran@flagright.com"
63       ],
64       "contactNumbers": [
65         "+37112345432"
66       ],
67       "faxNumbers": [
68         "faxNumbers"
69       ],
70       "websites": [
71         "flagright.com"
72       ],
73       "addresses": [
74         {
75           "addressLines": [
76             "Klara-Franke Str 20"
77           ],
78           "postcode": "10557",
79           "city": "Berlin",
80           "state": "Berlin",
81           "country": "Germany",
82           "tags": [
83             {
84               "key": "customKey",
85               "value": "customValue"
86             }
87           ]
88         }
89       ]
90     },
91     "employmentDetails": {
92       "employmentSector": "employmentSector",
93       "employerName": "employerName",
94       "businessIndustry": [
95         "businessIndustry"
96       ]
97     },
98     "transactionLimits": {
99       "maximumDailyTransactionLimit": {
100         "amountValue": 800,
101         "amountCurrency": "GBP"
102       },
103       "maximumWeeklyTransactionLimit": {
104         "amountValue": 800,
105         "amountCurrency": "GBP"
106       },
107       "maximumMonthlyTransactionLimit": {
108         "amountValue": 800,
109         "amountCurrency": "GBP"
110       },
111       "maximumQuarterlyTransactionLimit": {
112         "amountValue": 800,
113         "amountCurrency": "GBP"
114       },
115       "maximumTransactionLimit": {
116         "amountValue": 800,
117         "amountCurrency": "GBP"
118       },
119       "maximumYearlyTransactionLimit": {
120         "amountValue": 800,
121         "amountCurrency": "GBP"
122       }
123     },
124     "expectedIncome": {
125       "dailyExpectedIncome": {
126         "amountValue": 800,
127         "amountCurrency": "GBP"
128       },
129       "weeklyExpectedIncome": {
130         "amountValue": 800,
131         "amountCurrency": "GBP"
132       },
133       "monthlyExpectedIncome": {
134         "amountValue": 800,
135         "amountCurrency": "GBP"
136       },
137       "quarterlyExpectedIncome": {
138         "amountValue": 800,
139         "amountCurrency": "GBP"
140       },
141       "yearlyExpectedIncome": {
142         "amountValue": 800,
143         "amountCurrency": "GBP"
144       }
145     },
146     "riskLevel": "VERY_HIGH",
147     "kycRiskLevel": "VERY_HIGH",
148     "acquisitionChannel": "ORGANIC",
149     "reasonForAccountOpening": [
150       "reasonForAccountOpening"
151     ],
152     "sourceOfFunds": [
153       "Earnings"
154     ],
155     "userSegment": "RETAIL",
156     "pepStatus": [
157       {
158         "isPepHit": true
159       }
160     ],
161     "lastTransactionTimestamp": 1.1,
162     "linkedEntities": {
163       "parentUserId": "parentUserId"
164     },
165     "savedPaymentDetails": [
166       {
167         "method": "CARD",
168         "3dsDone": true,
169         "cardBalance": {
170           "amountValue": 800,
171           "amountCurrency": "GBP"
172         },
173         "cardFingerprint": "20ac00fed8ef913aefb17cfae1097cce",
174         "cardIssuedCountry": "TR",
175         "nameOnCard": {
176           "firstName": "Baran",
177           "middleName": "Realblood",
178           "lastName": "Ozkan"
179         },
180         "tags": [
181           {
182             "key": "customKey",
183             "value": "customValue"
184           }
185         ],
186         "transactionReferenceField": "Deposit"
187       }
188     ],
189     "tags": [
190       {
191         "key": "customKey",
192         "value": "customValue"
193       }
194     ],
195     "attachments": [
196       {
197         "files": [
198           {
199             "s3Key": "s3Key",
200             "filename": "filename",
201             "size": 1.1
202           }
203         ],
204         "userId": "userId",
205         "comment": "Arun's tax information"
206       }
207     ]
208   },
209   "executedRules": [
210     {
211       "ruleInstanceId": "ruleInstanceId",
212       "ruleName": "Proof of funds for high value transactions",
213       "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
214       "ruleAction": "BLOCK",
215       "ruleHit": true,
216       "ruleId": "R-1a",
217       "executedAt": 1.1,
218       "vars": [
219         {
220           "value": {
221             "key": "value"
222           }
223         }
224       ],
225       "labels": [
226         "UNEXPECTED_BEHAVIOR"
227       ],
228       "nature": "AML",
229       "isShadow": true
230     }
231   ],
232   "hitRules": [
233     {
234       "ruleInstanceId": "ruleInstanceId",
235       "ruleName": "Proof of funds for high value transactions",
236       "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
237       "ruleAction": "BLOCK",
238       "ruleId": "R-1a",
239       "executedAt": 1.1,
240       "labels": [
241         "UNEXPECTED_BEHAVIOR"
242       ],
243       "nature": "FRAUD",
244       "isShadow": true
245     }
246   ],
247   "riskScoreDetails": {
248     "kycRiskScore": 1.1,
249     "craRiskScore": 1.1,
250     "kycRiskLevel": "VERY_HIGH",
251     "craRiskLevel": "VERY_HIGH"
252   }
253 }

GET a Consumer User Event

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

Path parameters

eventIdstringRequired

Unique Consumer User Event Identifier

Response

timestampdouble>=315529200000<=4133890801000

Timestamp of the event

userIdstring>=1 character

Transaction ID the event pertains to

eventIdstringOptional

Unique event ID

reasonstringOptional

Reason for the event or a state change

eventDescriptionstringOptional

Event description

updatedConsumerUserAttributesobjectOptional

Model for User details

executedRuleslist of objectsOptional

hitRuleslist of objectsOptional

riskScoreDetailsobjectOptional

Retrieve a Consumer User Event

GET a Consumer User Event

Path parameters

Headers

Response

Errors