Consumer User Events

Retrieve a Consumer User Event

GET

Path parameters

eventIdstringRequired
Unique Consumer User Event Identifier

Response

This endpoint returns an object
timestamp
double
Timestamp of the event
userId
string
Transaction ID the event pertains to
eventId
stringOptional
Unique event ID
reason
stringOptional
Reason for the event or a state change
eventDescription
stringOptional
Event description
updatedConsumerUserAttributes
objectOptional
Model for User details

Errors

GET
1curl 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 "userDetails": {
9 "name": {
10 "firstName": "Baran",
11 "middleName": "Realblood",
12 "lastName": "Ozkan"
13 },
14 "dateOfBirth": "1991-01-01",
15 "countryOfResidence": "US",
16 "countryOfNationality": "DE",
17 "gender": "M"
18 },
19 "userStateDetails": {
20 "state": "UNACCEPTABLE",
21 "userId": "userId",
22 "reason": "reason"
23 },
24 "kycStatusDetails": {
25 "reason": "reason",
26 "status": "SUCCESSFUL",
27 "userId": "userId"
28 },
29 "employmentStatus": "UNEMPLOYED",
30 "occupation": "occupation",
31 "legalDocuments": [
32 {
33 "documentType": "passport",
34 "documentNumber": "Z9431P",
35 "documentIssuedCountry": "DE",
36 "documentIssuedDate": 1639939034000,
37 "documentExpirationDate": 1839939034000,
38 "tags": [
39 {
40 "key": "customerType",
41 "value": "wallet"
42 }
43 ],
44 "nameOnDocument": {
45 "firstName": "Baran",
46 "middleName": "Realblood",
47 "lastName": "Ozkan"
48 }
49 }
50 ],
51 "contactDetails": {
52 "emailIds": [
53 "baran@flagright.com"
54 ],
55 "contactNumbers": [
56 "+37112345432"
57 ],
58 "faxNumbers": [
59 "faxNumbers"
60 ],
61 "websites": [
62 "flagright.com"
63 ],
64 "addresses": [
65 {
66 "addressLines": [
67 "Klara-Franke Str 20"
68 ],
69 "city": "Berlin",
70 "country": "Germany",
71 "postcode": "10557",
72 "state": "Berlin",
73 "tags": [
74 {
75 "key": "customKey",
76 "value": "customValue"
77 }
78 ]
79 }
80 ]
81 },
82 "transactionLimits": {
83 "maximumDailyTransactionLimit": {
84 "amountValue": 800,
85 "amountCurrency": "GBP"
86 },
87 "maximumWeeklyTransactionLimit": {
88 "amountValue": 800,
89 "amountCurrency": "GBP"
90 },
91 "maximumMonthlyTransactionLimit": {
92 "amountValue": 800,
93 "amountCurrency": "GBP"
94 },
95 "maximumQuarterlyTransactionLimit": {
96 "amountValue": 800,
97 "amountCurrency": "GBP"
98 },
99 "maximumTransactionLimit": {
100 "amountValue": 800,
101 "amountCurrency": "GBP"
102 },
103 "maximumYearlyTransactionLimit": {
104 "amountValue": 800,
105 "amountCurrency": "GBP"
106 }
107 },
108 "riskLevel": "VERY_HIGH",
109 "acquisitionChannel": "ORGANIC",
110 "reasonForAccountOpening": [
111 "reasonForAccountOpening"
112 ],
113 "sourceOfFunds": [
114 "Earnings"
115 ],
116 "userSegment": "RETAIL",
117 "pepStatus": [
118 {
119 "isPepHit": true
120 }
121 ],
122 "tags": [
123 {
124 "key": "customKey",
125 "value": "customValue"
126 }
127 ]
128 }
129}