Retrieve a Consumer User

GET

/consumer/users/:userId

GET

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

Try it

200example-1

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

GET Consumer User

/consumer/user endpoint allows you to operate on the Consumer User entity.

Calling GET /consumer/user/{userId} will return the entire user payload and rule execution results for the user with the corresponding userId

Path parameters

userIdstringRequired

Response

userIdstring>=1 character

Unique user ID

createdTimestampdouble>=315529200000<=4133890801000

Timestamp when userId is created

activatedTimestampdoubleOptional>=315529200000<=4133890801000

Timestamp when user was activated

userDetailsobjectOptional

Model for consumer user personal details

userStateDetailsobjectOptional

kycStatusDetailsobjectOptional

employmentStatusenumOptional

occupationstringOptional

legalDocumentslist of objectsOptional

User’s legal identity documents - See Document Model for details

contactDetailsobjectOptional

Model for business user contact information details

employmentDetailsobjectOptional

Details of User’s employment

transactionLimitsobjectOptional

Model for transaction limits for a given user

expectedIncomeobjectOptional

Model for expected income details

riskLevelenumOptional

Allowed values:

kycRiskLevelenumOptional

Allowed values:

acquisitionChannelenumOptional

Model for User acquisition channel

reasonForAccountOpeninglist of stringsOptional

sourceOfFundslist of enumsOptional

userSegmentenumOptional

Allowed values:

pepStatuslist of objectsOptional

lastTransactionTimestampdoubleOptional

Timestamp of the last successful transaction of the user

linkedEntitiesobjectOptional

savedPaymentDetailslist of objectsOptional

tagslist of objectsOptional

Additional information that can be added via tags

attachmentslist of objectsOptional

Uploaded user’s attachment

executedRuleslist of objectsOptional

hitRuleslist of objectsOptional

riskScoreDetailsobjectOptional

Retrieve a Consumer User

GET Consumer User

Path parameters

Headers

Response

Errors