Retrieve a Consumer User Event — Flagright

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

This endpoint returns an object.

timestampdouble

Timestamp of the event

userIdstring

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

Model for list of executed rules

hitRuleslist of objectsOptional

Model for list of hit rules

riskScoreDetailsobjectOptional

Errors

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

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 "countryOfNationality": "DE", 19 "gender": "M", 20 "maritalStatus": "DIVORCED", 21 "placeOfBirth": { 22 "country": "AF" 23 } 24 }, 25 "userStateDetails": { 26 "reason": "reason", 27 "state": "UNACCEPTABLE" 28 }, 29 "kycStatusDetails": { 30 "reason": "reason", 31 "status": "SUCCESSFUL" 32 }, 33 "employmentStatus": "UNEMPLOYED", 34 "occupation": "occupation", 35 "legalDocuments": [ 36 { 37 "documentType": "passport", 38 "documentNumber": "Z9431P", 39 "documentIssuedDate": 1639939034000, 40 "documentExpirationDate": 1839939034000, 41 "documentIssuedCountry": "DE", 42 "tags": [ 43 { 44 "key": "customerType", 45 "value": "wallet" 46 } 47 ], 48 "nameOnDocument": { 49 "firstName": "Baran", 50 "middleName": "Realblood", 51 "lastName": "Ozkan" 52 } 53 } 54 ], 55 "contactDetails": { 56 "emailIds": [ 57 "baran@flagright.com" 58 ], 59 "contactNumbers": [ 60 "+37112345432" 61 ], 62 "faxNumbers": [ 63 "faxNumbers" 64 ], 65 "websites": [ 66 "flagright.com" 67 ], 68 "addresses": [ 69 { 70 "addressLines": [ 71 "Klara-Franke Str 20" 72 ], 73 "postcode": "10557", 74 "city": "Berlin", 75 "state": "Berlin", 76 "country": "Germany", 77 "tags": [ 78 { 79 "key": "customKey", 80 "value": "customValue" 81 } 82 ] 83 } 84 ] 85 }, 86 "employmentDetails": { 87 "employmentSector": "employmentSector", 88 "employerName": "employerName", 89 "businessIndustry": [ 90 "businessIndustry" 91 ] 92 }, 93 "transactionLimits": { 94 "maximumDailyTransactionLimit": { 95 "amountValue": 800, 96 "amountCurrency": "GBP" 97 }, 98 "maximumWeeklyTransactionLimit": { 99 "amountValue": 800, 100 "amountCurrency": "GBP" 101 }, 102 "maximumMonthlyTransactionLimit": { 103 "amountValue": 800, 104 "amountCurrency": "GBP" 105 }, 106 "maximumQuarterlyTransactionLimit": { 107 "amountValue": 800, 108 "amountCurrency": "GBP" 109 }, 110 "maximumTransactionLimit": { 111 "amountValue": 800, 112 "amountCurrency": "GBP" 113 }, 114 "maximumYearlyTransactionLimit": { 115 "amountValue": 800, 116 "amountCurrency": "GBP" 117 } 118 }, 119 "expectedIncome": { 120 "dailyExpectedIncome": { 121 "amountValue": 800, 122 "amountCurrency": "GBP" 123 }, 124 "weeklyExpectedIncome": { 125 "amountValue": 800, 126 "amountCurrency": "GBP" 127 }, 128 "monthlyExpectedIncome": { 129 "amountValue": 800, 130 "amountCurrency": "GBP" 131 }, 132 "quarterlyExpectedIncome": { 133 "amountValue": 800, 134 "amountCurrency": "GBP" 135 }, 136 "yearlyExpectedIncome": { 137 "amountValue": 800, 138 "amountCurrency": "GBP" 139 } 140 }, 141 "riskLevel": "VERY_HIGH", 142 "acquisitionChannel": "ORGANIC", 143 "reasonForAccountOpening": [ 144 "reasonForAccountOpening" 145 ], 146 "sourceOfFunds": [ 147 "Earnings" 148 ], 149 "userSegment": "RETAIL", 150 "pepStatus": [ 151 { 152 "isPepHit": true 153 } 154 ], 155 "linkedEntities": { 156 "parentUserId": "parentUserId" 157 }, 158 "tags": [ 159 { 160 "key": "customKey", 161 "value": "customValue" 162 } 163 ] 164 }, 165 "executedRules": [ 166 { 167 "ruleId": "R-1a", 168 "ruleInstanceId": "ruleInstanceId", 169 "ruleName": "Proof of funds for high value transactions", 170 "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds", 171 "ruleAction": "BLOCK", 172 "ruleHit": true, 173 "vars": [ 174 { 175 "value": {} 176 } 177 ], 178 "labels": [ 179 "UNEXPECTED_BEHAVIOR" 180 ], 181 "nature": "AML", 182 "isShadow": true 183 } 184 ], 185 "hitRules": [ 186 { 187 "ruleId": "R-1a", 188 "ruleInstanceId": "ruleInstanceId", 189 "ruleName": "Proof of funds for high value transactions", 190 "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds", 191 "ruleAction": "BLOCK", 192 "labels": [ 193 "UNEXPECTED_BEHAVIOR" 194 ], 195 "nature": "FRAUD", 196 "isShadow": true 197 } 198 ], 199 "riskScoreDetails": { 200 "kycRiskScore": 1.1, 201 "craRiskScore": 1.1, 202 "kycRiskLevel": "VERY_HIGH", 203 "craRiskLevel": "VERY_HIGH" 204 } 205 }

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

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	"countryOfNationality": "DE",
19	"gender": "M",
20	"maritalStatus": "DIVORCED",
21	"placeOfBirth": {
22	"country": "AF"
23	}
24	},
25	"userStateDetails": {
26	"reason": "reason",
27	"state": "UNACCEPTABLE"
28	},
29	"kycStatusDetails": {
30	"reason": "reason",
31	"status": "SUCCESSFUL"
32	},
33	"employmentStatus": "UNEMPLOYED",
34	"occupation": "occupation",
35	"legalDocuments": [
36	{
37	"documentType": "passport",
38	"documentNumber": "Z9431P",
39	"documentIssuedDate": 1639939034000,
40	"documentExpirationDate": 1839939034000,
41	"documentIssuedCountry": "DE",
42	"tags": [
43	{
44	"key": "customerType",
45	"value": "wallet"
46	}
47	],
48	"nameOnDocument": {
49	"firstName": "Baran",
50	"middleName": "Realblood",
51	"lastName": "Ozkan"
52	}
53	}
54	],
55	"contactDetails": {
56	"emailIds": [
57	"baran@flagright.com"
58	],
59	"contactNumbers": [
60	"+37112345432"
61	],
62	"faxNumbers": [
63	"faxNumbers"
64	],
65	"websites": [
66	"flagright.com"
67	],
68	"addresses": [
69	{
70	"addressLines": [
71	"Klara-Franke Str 20"
72	],
73	"postcode": "10557",
74	"city": "Berlin",
75	"state": "Berlin",
76	"country": "Germany",
77	"tags": [
78	{
79	"key": "customKey",
80	"value": "customValue"
81	}
82	]
83	}
84	]
85	},
86	"employmentDetails": {
87	"employmentSector": "employmentSector",
88	"employerName": "employerName",
89	"businessIndustry": [
90	"businessIndustry"
91	]
92	},
93	"transactionLimits": {
94	"maximumDailyTransactionLimit": {
95	"amountValue": 800,
96	"amountCurrency": "GBP"
97	},
98	"maximumWeeklyTransactionLimit": {
99	"amountValue": 800,
100	"amountCurrency": "GBP"
101	},
102	"maximumMonthlyTransactionLimit": {
103	"amountValue": 800,
104	"amountCurrency": "GBP"
105	},
106	"maximumQuarterlyTransactionLimit": {
107	"amountValue": 800,
108	"amountCurrency": "GBP"
109	},
110	"maximumTransactionLimit": {
111	"amountValue": 800,
112	"amountCurrency": "GBP"
113	},
114	"maximumYearlyTransactionLimit": {
115	"amountValue": 800,
116	"amountCurrency": "GBP"
117	}
118	},
119	"expectedIncome": {
120	"dailyExpectedIncome": {
121	"amountValue": 800,
122	"amountCurrency": "GBP"
123	},
124	"weeklyExpectedIncome": {
125	"amountValue": 800,
126	"amountCurrency": "GBP"
127	},
128	"monthlyExpectedIncome": {
129	"amountValue": 800,
130	"amountCurrency": "GBP"
131	},
132	"quarterlyExpectedIncome": {
133	"amountValue": 800,
134	"amountCurrency": "GBP"
135	},
136	"yearlyExpectedIncome": {
137	"amountValue": 800,
138	"amountCurrency": "GBP"
139	}
140	},
141	"riskLevel": "VERY_HIGH",
142	"acquisitionChannel": "ORGANIC",
143	"reasonForAccountOpening": [
144	"reasonForAccountOpening"
145	],
146	"sourceOfFunds": [
147	"Earnings"
148	],
149	"userSegment": "RETAIL",
150	"pepStatus": [
151	{
152	"isPepHit": true
153	}
154	],
155	"linkedEntities": {
156	"parentUserId": "parentUserId"
157	},
158	"tags": [
159	{
160	"key": "customKey",
161	"value": "customValue"
162	}
163	]
164	},
165	"executedRules": [
166	{
167	"ruleId": "R-1a",
168	"ruleInstanceId": "ruleInstanceId",
169	"ruleName": "Proof of funds for high value transactions",
170	"ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
171	"ruleAction": "BLOCK",
172	"ruleHit": true,
173	"vars": [
174	{
175	"value": {}
176	}
177	],
178	"labels": [
179	"UNEXPECTED_BEHAVIOR"
180	],
181	"nature": "AML",
182	"isShadow": true
183	}
184	],
185	"hitRules": [
186	{
187	"ruleId": "R-1a",
188	"ruleInstanceId": "ruleInstanceId",
189	"ruleName": "Proof of funds for high value transactions",
190	"ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
191	"ruleAction": "BLOCK",
192	"labels": [
193	"UNEXPECTED_BEHAVIOR"
194	],
195	"nature": "FRAUD",
196	"isShadow": true
197	}
198	],
199	"riskScoreDetails": {
200	"kycRiskScore": 1.1,
201	"craRiskScore": 1.1,
202	"kycRiskLevel": "VERY_HIGH",
203	"craRiskLevel": "VERY_HIGH"
204	}
205	}