Consumer Users

Retrieve a Consumer User

GET

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

This endpoint returns an object

userId

string

Unique user ID

createdTimestamp

double

Timestamp when userId is created

activatedTimestamp

doubleOptional

Timestamp when user was activated

userDetails

objectOptional

Model for consumer user personal details

userStateDetails

objectOptional

kycStatusDetails

objectOptional

employmentStatus

enumOptional

occupation

stringOptional

legalDocuments

list of objectsOptional

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

contactDetails

objectOptional

Model for business user contact information details

transactionLimits

objectOptional

Model for transaction limits for a given user

expectedIncome

objectOptional

Model for expected income details

riskLevel

enumOptional

Allowed values: VERY_HIGHHIGHMEDIUMLOWVERY_LOW

acquisitionChannel

enumOptional

Model for User acquisition channel

reasonForAccountOpening

list of stringsOptional

sourceOfFunds

list of enumsOptional

userSegment

enumOptional

Allowed values: RETAILPROFESSIONAL

pepStatus

list of objectsOptional

linkedEntities

objectOptional

savedPaymentDetails

list of unionsOptional

Errors

GET

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

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

Built with

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

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