Retrieve a Consumer User | Flagright

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

Authentication

x-api-keystring

API Key authentication via header

Path parameters

userIdstringRequired

Response

userIdstring>=1 character

Unique user ID

createdTimestampdouble315529200000-4133890801000

Timestamp when userId is created

activatedTimestampdouble or null315529200000-4133890801000

Timestamp when user was activated

userDetailsobject or null

Model for consumer user personal details

userStateDetailsobject or null

kycStatusDetailsobject or null

eoddDatedouble or null

employmentStatusenum or null

occupationstring or null

legalDocumentslist of objects or null

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

contactDetailsobject or null

Model for business user contact information details

employmentDetailsobject or null

Details of User's employment

transactionLimitsobject or null

Model for transaction limits for a given user

expectedIncomeobject or null

Model for expected income details

riskLevelenum or null

Allowed values:

kycRiskLevelenum or null

Allowed values:

acquisitionChannelenum or null

Model for User acquisition channel

reasonForAccountOpeninglist of strings or null

sourceOfFundslist of enums or null

userSegmentenum or null

Allowed values:

pepStatuslist of objects or null

sanctionsStatusboolean or null

adverseMediaStatusboolean or null

corporateEntitieslist of objects or null

Corporate entities of the user

linkedEntitiesobject or null

savedPaymentDetailslist of objects or null

tagslist of objects or null

Additional information that can be added via tags

attachmentslist of objects or null

Uploaded user's attachment

metaDataobject or null

Model for device data

jurisdictionstring or null

Legal authority or region governing the transaction

productsEnabledlist of objects or null

executedRuleslist of objects or null

hitRuleslist of objects or null

riskScoreDetailsobject or null

1	from flagright import Flagright
2
3	client = Flagright(
4	api_key="YOUR_API_KEY",
5	)
6	client.consumer_users.get(
7	user_id="userId",
8	)

1	{
2	"userId": "96647cfd9e8fe66ee0f3362e011e34e8",
3	"createdTimestamp": 1641654664000,
4	"userDetails": {
5	"name": {
6	"firstName": "Baran",
7	"middleName": "Realblood",
8	"lastName": "Ozkan"
9	},
10	"dateOfBirth": "1991-01-01",
11	"countryOfResidence": "US",
12	"countryOfNationality": "DE"
13	},
14	"legalDocuments": [
15	{
16	"documentType": "passport",
17	"documentNumber": "Z9431P",
18	"documentIssuedCountry": "DE",
19	"documentIssuedDate": 1639939034000,
20	"documentExpirationDate": 1839939034000,
21	"tags": [
22	{
23	"key": "customerType",
24	"value": "wallet"
25	}
26	]
27	}
28	],
29	"contactDetails": {
30	"emailIds": [
31	"baran@flagright.com"
32	],
33	"contactNumbers": [
34	"+37112345432"
35	],
36	"websites": [
37	"flagright.com"
38	],
39	"addresses": [
40	{
41	"addressLines": [
42	"Klara-Franke Str 20"
43	],
44	"postcode": "10557",
45	"city": "Berlin",
46	"state": "Berlin",
47	"country": "Germany",
48	"tags": [
49	{
50	"key": "customKey",
51	"value": "customValue"
52	}
53	]
54	}
55	]
56	},
57	"tags": [
58	{
59	"key": "customKey",
60	"value": "customValue"
61	}
62	],
63	"riskScoreDetails": {
64	"kycRiskScore": 11.72,
65	"craRiskScore": 41.72,
66	"kycRiskLevel": "MEDIUM",
67	"craRiskLevel": "HIGH"
68	}
69	}

GET Consumer User

Authentication

Path parameters

Response

Errors