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 keys are used to authenticate the requests.

Path parameters

userIdstringRequired

Response

userIdstring>=1 character

Unique user ID

createdTimestampdouble315529200000-4133890801000

Timestamp when userId is created

activatedTimestampdouble315529200000-4133890801000

Timestamp when user was activated

userDetailsobject

Model for consumer user personal details

userStateDetailsobject

kycStatusDetailsobject

eoddDatedouble315529200000-4133890801000

employmentStatusenum

occupationstring

legalDocumentslist of objects

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

contactDetailsobject

Model for business user contact information details

employmentDetailsobject

Details of User's employment

transactionLimitsobject

Model for transaction limits for a given user

expectedIncomeobject

Model for expected income details

expectedTransactionCountriesobject

Model for expected transaction countries

expectedTransactionCurrenciesobject

Model for expected transaction currencies

riskLevelenum

Allowed values:

kycRiskLevelenum

Allowed values:

acquisitionChannelenum

Model for User acquisition channel

reasonForAccountOpeninglist of strings

sourceOfFundslist of enums

userSegmentenum

Allowed values:

pepStatuslist of objects

sanctionsStatusboolean

adverseMediaStatusboolean

corporateEntitieslist of objects

Corporate entities of the user

linkedEntitiesobject

savedPaymentDetailslist of objects

tagslist of objects

Additional information that can be added via tags

attachmentslist of objects

Uploaded user's attachment

metaDataobject

Model for device data

jurisdictionstring

Legal authority or region governing the transaction

productsEnabledlist of objects

externalLinkslist of strings

External links related to the consumer user

executedRuleslist of objects

hitRuleslist of objects

riskScoreDetailsobject

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error

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	"documentIssuedDate": 1639939034000,
19	"documentExpirationDate": 1839939034000,
20	"documentIssuedCountry": "DE",
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	}

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