Retrieve a Consumer User

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

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