Retrieve a consumer user batch

GET

/batch/consumer/users/:batchId

GET

/batch/consumer/users/:batchId

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

Try it

200Retrieved

1 {
2   "consumerUsers": [
3     {
4       "userId": "string",
5       "createdTimestamp": 2220000000000,
6       "activatedTimestamp": 2220000000000,
7       "userDetails": {
8         "name": {
9           "firstName": "string",
10           "middleName": "string",
11           "lastName": "string"
12         },
13         "dateOfBirth": "string",
14         "userCategory": "string",
15         "countryOfResidence": "AF",
16         "countryOfTaxResidence": "AF",
17         "countryOfNationality": "AF",
18         "gender": "M",
19         "maritalStatus": "DIVORCED",
20         "placeOfBirth": {
21           "country": "AF",
22           "city": "string",
23           "state": "string"
24         },
25         "alias": [
26           "string"
27         ]
28       },
29       "userStateDetails": {
30         "state": "UNACCEPTABLE",
31         "reason": "string"
32       },
33       "kycStatusDetails": {
34         "reason": "string",
35         "status": "SUCCESSFUL"
36       },
37       "eoddDate": 1.1,
38       "employmentStatus": "UNEMPLOYED",
39       "occupation": "string",
40       "legalDocuments": [
41         {
42           "documentType": "string",
43           "documentNumber": "string",
44           "documentIssuedCountry": "AF",
45           "documentIssuedDate": 1.1,
46           "documentExpirationDate": 1.1,
47           "tags": [
48             {
49               "key": "string",
50               "value": "string",
51               "isTimestamp": true
52             }
53           ],
54           "nameOnDocument": {
55             "firstName": "string",
56             "middleName": "string",
57             "lastName": "string"
58           }
59         }
60       ],
61       "contactDetails": {
62         "emailIds": [
63           "string"
64         ],
65         "contactNumbers": [
66           "string"
67         ],
68         "faxNumbers": [
69           "string"
70         ],
71         "websites": [
72           "string"
73         ],
74         "addresses": [
75           {
76             "addressLines": [
77               "string"
78             ],
79             "postcode": "string",
80             "city": "string",
81             "state": "string",
82             "country": "string",
83             "addressType": "string",
84             "tags": [
85               {
86                 "key": "string",
87                 "value": "string",
88                 "isTimestamp": true
89               }
90             ]
91           }
92         ],
93         "name": {
94           "firstName": "string",
95           "middleName": "string",
96           "lastName": "string"
97         },
98         "tags": [
99           {
100             "key": "string",
101             "value": "string",
102             "isTimestamp": true
103           }
104         ]
105       },
106       "employmentDetails": {
107         "employmentSector": "string",
108         "employerName": "string",
109         "businessIndustry": [
110           "string"
111         ]
112       },
113       "transactionLimits": {
114         "maximumDailyTransactionLimit": {
115           "amountValue": 1.1,
116           "amountCurrency": "1INCH"
117         },
118         "maximumWeeklyTransactionLimit": {
119           "amountValue": 1.1,
120           "amountCurrency": "1INCH"
121         },
122         "maximumMonthlyTransactionLimit": {
123           "amountValue": 1.1,
124           "amountCurrency": "1INCH"
125         },
126         "maximumQuarterlyTransactionLimit": {
127           "amountValue": 1.1,
128           "amountCurrency": "1INCH"
129         },
130         "maximumTransactionLimit": {
131           "amountValue": 1.1,
132           "amountCurrency": "1INCH"
133         },
134         "maximumYearlyTransactionLimit": {
135           "amountValue": 1.1,
136           "amountCurrency": "1INCH"
137         },
138         "paymentMethodLimits": {
139           "ACH": {
140             "transactionCountLimit": {
141               "day": 1.1,
142               "week": 1.1,
143               "month": 1.1,
144               "year": 1.1
145             },
146             "transactionAmountLimit": {
147               "day": {
148                 "amountValue": 1.1,
149                 "amountCurrency": "1INCH"
150               },
151               "week": {
152                 "amountValue": 1.1,
153                 "amountCurrency": "1INCH"
154               },
155               "month": {
156                 "amountValue": 1.1,
157                 "amountCurrency": "1INCH"
158               },
159               "year": {
160                 "amountValue": 1.1,
161                 "amountCurrency": "1INCH"
162               }
163             },
164             "averageTransactionAmountLimit": {
165               "day": {
166                 "amountValue": 1.1,
167                 "amountCurrency": "1INCH"
168               },
169               "week": {
170                 "amountValue": 1.1,
171                 "amountCurrency": "1INCH"
172               },
173               "month": {
174                 "amountValue": 1.1,
175                 "amountCurrency": "1INCH"
176               },
177               "year": {
178                 "amountValue": 1.1,
179                 "amountCurrency": "1INCH"
180               }
181             }
182           },
183           "CARD": {
184             "transactionCountLimit": {
185               "day": 1.1,
186               "week": 1.1,
187               "month": 1.1,
188               "year": 1.1
189             },
190             "transactionAmountLimit": {
191               "day": {
192                 "amountValue": 1.1,
193                 "amountCurrency": "1INCH"
194               },
195               "week": {
196                 "amountValue": 1.1,
197                 "amountCurrency": "1INCH"
198               },
199               "month": {
200                 "amountValue": 1.1,
201                 "amountCurrency": "1INCH"
202               },
203               "year": {
204                 "amountValue": 1.1,
205                 "amountCurrency": "1INCH"
206               }
207             },
208             "averageTransactionAmountLimit": {
209               "day": {
210                 "amountValue": 1.1,
211                 "amountCurrency": "1INCH"
212               },
213               "week": {
214                 "amountValue": 1.1,
215                 "amountCurrency": "1INCH"
216               },
217               "month": {
218                 "amountValue": 1.1,
219                 "amountCurrency": "1INCH"
220               },
221               "year": {
222                 "amountValue": 1.1,
223                 "amountCurrency": "1INCH"
224               }
225             }
226           },
227           "IBAN": {
228             "transactionCountLimit": {
229               "day": 1.1,
230               "week": 1.1,
231               "month": 1.1,
232               "year": 1.1
233             },
234             "transactionAmountLimit": {
235               "day": {
236                 "amountValue": 1.1,
237                 "amountCurrency": "1INCH"
238               },
239               "week": {
240                 "amountValue": 1.1,
241                 "amountCurrency": "1INCH"
242               },
243               "month": {
244                 "amountValue": 1.1,
245                 "amountCurrency": "1INCH"
246               },
247               "year": {
248                 "amountValue": 1.1,
249                 "amountCurrency": "1INCH"
250               }
251             },
252             "averageTransactionAmountLimit": {
253               "day": {
254                 "amountValue": 1.1,
255                 "amountCurrency": "1INCH"
256               },
257               "week": {
258                 "amountValue": 1.1,
259                 "amountCurrency": "1INCH"
260               },
261               "month": {
262                 "amountValue": 1.1,
263                 "amountCurrency": "1INCH"
264               },
265               "year": {
266                 "amountValue": 1.1,
267                 "amountCurrency": "1INCH"
268               }
269             }
270           },
271           "UPI": {
272             "transactionCountLimit": {
273               "day": 1.1,
274               "week": 1.1,
275               "month": 1.1,
276               "year": 1.1
277             },
278             "transactionAmountLimit": {
279               "day": {
280                 "amountValue": 1.1,
281                 "amountCurrency": "1INCH"
282               },
283               "week": {
284                 "amountValue": 1.1,
285                 "amountCurrency": "1INCH"
286               },
287               "month": {
288                 "amountValue": 1.1,
289                 "amountCurrency": "1INCH"
290               },
291               "year": {
292                 "amountValue": 1.1,
293                 "amountCurrency": "1INCH"
294               }
295             },
296             "averageTransactionAmountLimit": {
297               "day": {
298                 "amountValue": 1.1,
299                 "amountCurrency": "1INCH"
300               },
301               "week": {
302                 "amountValue": 1.1,
303                 "amountCurrency": "1INCH"
304               },
305               "month": {
306                 "amountValue": 1.1,
307                 "amountCurrency": "1INCH"
308               },
309               "year": {
310                 "amountValue": 1.1,
311                 "amountCurrency": "1INCH"
312               }
313             }
314           },
315           "GENERIC_BANK_ACCOUNT": {
316             "transactionCountLimit": {
317               "day": 1.1,
318               "week": 1.1,
319               "month": 1.1,
320               "year": 1.1
321             },
322             "transactionAmountLimit": {
323               "day": {
324                 "amountValue": 1.1,
325                 "amountCurrency": "1INCH"
326               },
327               "week": {
328                 "amountValue": 1.1,
329                 "amountCurrency": "1INCH"
330               },
331               "month": {
332                 "amountValue": 1.1,
333                 "amountCurrency": "1INCH"
334               },
335               "year": {
336                 "amountValue": 1.1,
337                 "amountCurrency": "1INCH"
338               }
339             },
340             "averageTransactionAmountLimit": {
341               "day": {
342                 "amountValue": 1.1,
343                 "amountCurrency": "1INCH"
344               },
345               "week": {
346                 "amountValue": 1.1,
347                 "amountCurrency": "1INCH"
348               },
349               "month": {
350                 "amountValue": 1.1,
351                 "amountCurrency": "1INCH"
352               },
353               "year": {
354                 "amountValue": 1.1,
355                 "amountCurrency": "1INCH"
356               }
357             }
358           },
359           "MPESA": {
360             "transactionCountLimit": {
361               "day": 1.1,
362               "week": 1.1,
363               "month": 1.1,
364               "year": 1.1
365             },
366             "transactionAmountLimit": {
367               "day": {
368                 "amountValue": 1.1,
369                 "amountCurrency": "1INCH"
370               },
371               "week": {
372                 "amountValue": 1.1,
373                 "amountCurrency": "1INCH"
374               },
375               "month": {
376                 "amountValue": 1.1,
377                 "amountCurrency": "1INCH"
378               },
379               "year": {
380                 "amountValue": 1.1,
381                 "amountCurrency": "1INCH"
382               }
383             },
384             "averageTransactionAmountLimit": {
385               "day": {
386                 "amountValue": 1.1,
387                 "amountCurrency": "1INCH"
388               },
389               "week": {
390                 "amountValue": 1.1,
391                 "amountCurrency": "1INCH"
392               },
393               "month": {
394                 "amountValue": 1.1,
395                 "amountCurrency": "1INCH"
396               },
397               "year": {
398                 "amountValue": 1.1,
399                 "amountCurrency": "1INCH"
400               }
401             }
402           },
403           "SWIFT": {
404             "transactionCountLimit": {
405               "day": 1.1,
406               "week": 1.1,
407               "month": 1.1,
408               "year": 1.1
409             },
410             "transactionAmountLimit": {
411               "day": {
412                 "amountValue": 1.1,
413                 "amountCurrency": "1INCH"
414               },
415               "week": {
416                 "amountValue": 1.1,
417                 "amountCurrency": "1INCH"
418               },
419               "month": {
420                 "amountValue": 1.1,
421                 "amountCurrency": "1INCH"
422               },
423               "year": {
424                 "amountValue": 1.1,
425                 "amountCurrency": "1INCH"
426               }
427             },
428             "averageTransactionAmountLimit": {
429               "day": {
430                 "amountValue": 1.1,
431                 "amountCurrency": "1INCH"
432               },
433               "week": {
434                 "amountValue": 1.1,
435                 "amountCurrency": "1INCH"
436               },
437               "month": {
438                 "amountValue": 1.1,
439                 "amountCurrency": "1INCH"
440               },
441               "year": {
442                 "amountValue": 1.1,
443                 "amountCurrency": "1INCH"
444               }
445             }
446           },
447           "WALLET": {
448             "transactionCountLimit": {
449               "day": 1.1,
450               "week": 1.1,
451               "month": 1.1,
452               "year": 1.1
453             },
454             "transactionAmountLimit": {
455               "day": {
456                 "amountValue": 1.1,
457                 "amountCurrency": "1INCH"
458               },
459               "week": {
460                 "amountValue": 1.1,
461                 "amountCurrency": "1INCH"
462               },
463               "month": {
464                 "amountValue": 1.1,
465                 "amountCurrency": "1INCH"
466               },
467               "year": {
468                 "amountValue": 1.1,
469                 "amountCurrency": "1INCH"
470               }
471             },
472             "averageTransactionAmountLimit": {
473               "day": {
474                 "amountValue": 1.1,
475                 "amountCurrency": "1INCH"
476               },
477               "week": {
478                 "amountValue": 1.1,
479                 "amountCurrency": "1INCH"
480               },
481               "month": {
482                 "amountValue": 1.1,
483                 "amountCurrency": "1INCH"
484               },
485               "year": {
486                 "amountValue": 1.1,
487                 "amountCurrency": "1INCH"
488               }
489             }
490           },
491           "CHECK": {
492             "transactionCountLimit": {
493               "day": 1.1,
494               "week": 1.1,
495               "month": 1.1,
496               "year": 1.1
497             },
498             "transactionAmountLimit": {
499               "day": {
500                 "amountValue": 1.1,
501                 "amountCurrency": "1INCH"
502               },
503               "week": {
504                 "amountValue": 1.1,
505                 "amountCurrency": "1INCH"
506               },
507               "month": {
508                 "amountValue": 1.1,
509                 "amountCurrency": "1INCH"
510               },
511               "year": {
512                 "amountValue": 1.1,
513                 "amountCurrency": "1INCH"
514               }
515             },
516             "averageTransactionAmountLimit": {
517               "day": {
518                 "amountValue": 1.1,
519                 "amountCurrency": "1INCH"
520               },
521               "week": {
522                 "amountValue": 1.1,
523                 "amountCurrency": "1INCH"
524               },
525               "month": {
526                 "amountValue": 1.1,
527                 "amountCurrency": "1INCH"
528               },
529               "year": {
530                 "amountValue": 1.1,
531                 "amountCurrency": "1INCH"
532               }
533             }
534           },
535           "CASH": {
536             "transactionCountLimit": {
537               "day": 1.1,
538               "week": 1.1,
539               "month": 1.1,
540               "year": 1.1
541             },
542             "transactionAmountLimit": {
543               "day": {
544                 "amountValue": 1.1,
545                 "amountCurrency": "1INCH"
546               },
547               "week": {
548                 "amountValue": 1.1,
549                 "amountCurrency": "1INCH"
550               },
551               "month": {
552                 "amountValue": 1.1,
553                 "amountCurrency": "1INCH"
554               },
555               "year": {
556                 "amountValue": 1.1,
557                 "amountCurrency": "1INCH"
558               }
559             },
560             "averageTransactionAmountLimit": {
561               "day": {
562                 "amountValue": 1.1,
563                 "amountCurrency": "1INCH"
564               },
565               "week": {
566                 "amountValue": 1.1,
567                 "amountCurrency": "1INCH"
568               },
569               "month": {
570                 "amountValue": 1.1,
571                 "amountCurrency": "1INCH"
572               },
573               "year": {
574                 "amountValue": 1.1,
575                 "amountCurrency": "1INCH"
576               }
577             }
578           },
579           "NPP": {
580             "transactionCountLimit": {
581               "day": 1.1,
582               "week": 1.1,
583               "month": 1.1,
584               "year": 1.1
585             },
586             "transactionAmountLimit": {
587               "day": {
588                 "amountValue": 1.1,
589                 "amountCurrency": "1INCH"
590               },
591               "week": {
592                 "amountValue": 1.1,
593                 "amountCurrency": "1INCH"
594               },
595               "month": {
596                 "amountValue": 1.1,
597                 "amountCurrency": "1INCH"
598               },
599               "year": {
600                 "amountValue": 1.1,
601                 "amountCurrency": "1INCH"
602               }
603             },
604             "averageTransactionAmountLimit": {
605               "day": {
606                 "amountValue": 1.1,
607                 "amountCurrency": "1INCH"
608               },
609               "week": {
610                 "amountValue": 1.1,
611                 "amountCurrency": "1INCH"
612               },
613               "month": {
614                 "amountValue": 1.1,
615                 "amountCurrency": "1INCH"
616               },
617               "year": {
618                 "amountValue": 1.1,
619                 "amountCurrency": "1INCH"
620               }
621             }
622           }
623         }
624       },
625       "expectedIncome": {
626         "dailyExpectedIncome": {
627           "amountValue": 1.1,
628           "amountCurrency": "1INCH"
629         },
630         "weeklyExpectedIncome": {
631           "amountValue": 1.1,
632           "amountCurrency": "1INCH"
633         },
634         "monthlyExpectedIncome": {
635           "amountValue": 1.1,
636           "amountCurrency": "1INCH"
637         },
638         "quarterlyExpectedIncome": {
639           "amountValue": 1.1,
640           "amountCurrency": "1INCH"
641         },
642         "yearlyExpectedIncome": {
643           "amountValue": 1.1,
644           "amountCurrency": "1INCH"
645         }
646       },
647       "expectedTransactionCountries": {
648         "incoming": [
649           {
650             "countryCode": "AF"
651           }
652         ],
653         "outgoing": [
654           {
655             "countryCode": "AF"
656           }
657         ]
658       },
659       "riskLevel": "VERY_HIGH",
660       "kycRiskLevel": "VERY_HIGH",
661       "acquisitionChannel": "ORGANIC",
662       "reasonForAccountOpening": [
663         "string"
664       ],
665       "sourceOfFunds": [
666         "Earnings"
667       ],
668       "userSegment": "RETAIL",
669       "pepStatus": [
670         {
671           "isPepHit": true,
672           "pepCountry": "AF",
673           "pepRank": "LEVEL_1",
674           "category": "string"
675         }
676       ],
677       "sanctionsStatus": true,
678       "adverseMediaStatus": true,
679       "corporateEntities": [
680         {
681           "legalName": "string"
682         }
683       ],
684       "linkedEntities": {
685         "parentUserId": "string"
686       },
687       "savedPaymentDetails": [
688         {
689           "method": "CARD",
690           "counterpartyType": "INDIVIDUAL",
691           "cardFingerprint": "string",
692           "emailId": "string",
693           "cardStatus": "ACTIVE",
694           "cardIssuedCountry": "AF",
695           "transactionReferenceField": "string",
696           "3dsDone": true,
697           "nameOnCard": {
698             "firstName": "string",
699             "middleName": "string",
700             "lastName": "string"
701           },
702           "cardExpiry": {
703             "month": 1.1,
704             "year": 1.1
705           },
706           "posDetails": {
707             "entryMode": "0"
708           },
709           "cardLast4Digits": "string",
710           "cardBrand": "VISA",
711           "cardFunding": "CREDIT",
712           "cardAuthenticated": true,
713           "cardTokenized": true,
714           "cardPresent": true,
715           "paymentChannel": "string",
716           "cardType": "VIRTUAL",
717           "cardBalance": {
718             "amountValue": 1.1,
719             "amountCurrency": "1INCH"
720           },
721           "merchantDetails": {
722             "id": "string",
723             "name": "string",
724             "category": "string",
725             "MCC": "string",
726             "city": "string",
727             "country": "AF",
728             "state": "string",
729             "postCode": "string"
730           },
731           "networkProviderRiskScore": 1.1,
732           "address": {
733             "addressLines": [
734               "string"
735             ],
736             "postcode": "string",
737             "city": "string",
738             "state": "string",
739             "country": "string",
740             "addressType": "string",
741             "tags": [
742               {
743                 "key": "string",
744                 "value": "string",
745                 "isTimestamp": true
746               }
747             ]
748           },
749           "countryOfNationality": "AF",
750           "countryOfResidence": "AF",
751           "bankAddress": {
752             "addressLines": [
753               "string"
754             ],
755             "postcode": "string",
756             "city": "string",
757             "state": "string",
758             "country": "string",
759             "addressType": "string",
760             "tags": [
761               {
762                 "key": "string",
763                 "value": "string",
764                 "isTimestamp": true
765               }
766             ]
767           },
768           "tags": [
769             {
770               "key": "string",
771               "value": "string",
772               "isTimestamp": true
773             }
774           ]
775         }
776       ],
777       "tags": [
778         {
779           "key": "string",
780           "value": "string",
781           "isTimestamp": true,
782           "isEditable": true
783         }
784       ],
785       "attachments": [
786         {
787           "files": [
788             {
789               "s3Key": "string",
790               "filename": "string",
791               "size": 1.1,
792               "bucket": "string",
793               "downloadLink": "string",
794               "aiSummary": "string"
795             }
796           ],
797           "userId": "string",
798           "id": "string",
799           "comment": "string",
800           "createdAt": 1.1,
801           "deletedAt": 1.1,
802           "tags": [
803             "string"
804           ]
805         }
806       ],
807       "metaData": {
808         "batteryLevel": 1.1,
809         "deviceLatitude": 1.1,
810         "deviceLongitude": 1.1,
811         "ipAddress": "string",
812         "ipCountry": "AF",
813         "deviceIdentifier": "string",
814         "vpnUsed": true,
815         "operatingSystem": "string",
816         "deviceMaker": "string",
817         "deviceModel": "string",
818         "deviceYear": "string",
819         "appVersion": "string"
820       },
821       "jurisdiction": "string",
822       "productsEnabled": [
823         {
824           "productName": "string"
825         }
826       ],
827       "executedRules": [
828         {
829           "ruleInstanceId": "string",
830           "ruleName": "string",
831           "ruleDescription": "string",
832           "ruleAction": "ALLOW",
833           "ruleHit": true,
834           "ruleId": "string",
835           "versionId": "string",
836           "executedAt": 2220000000000,
837           "ruleHitMeta": {
838             "hitDirections": [
839               "ORIGIN"
840             ],
841             "falsePositiveDetails": {
842               "isFalsePositive": true,
843               "confidenceScore": 1.1
844             },
845             "sanctionsDetails": [
846               {
847                 "name": "string",
848                 "searchId": "string",
849                 "iban": "string",
850                 "entityType": "CONSUMER_NAME",
851                 "sanctionHitIds": [
852                   "string"
853                 ],
854                 "hitContext": {
855                   "entity": "USER",
856                   "entityType": "CONSUMER_NAME",
857                   "userId": "string",
858                   "transactionId": "string",
859                   "ruleInstanceId": "string",
860                   "ruleId": "string",
861                   "iban": "string",
862                   "yearOfBirth": 1.1,
863                   "searchTerm": "string",
864                   "paymentMethodId": "string"
865                 },
866                 "hitDirection": "ORIGIN",
867                 "isRuleHit": true
868               }
869             ],
870             "isOngoingScreeningHit": true
871           },
872           "vars": [
873             {
874               "value": {},
875               "direction": "ORIGIN"
876             }
877           ],
878           "labels": [
879             "UNEXPECTED_BEHAVIOR"
880           ],
881           "nature": "AML",
882           "isShadow": true
883         }
884       ],
885       "riskScoreDetails": {
886         "kycRiskScore": 1.1,
887         "craRiskScore": 1.1,
888         "kycRiskLevel": "VERY_HIGH",
889         "craRiskLevel": "VERY_HIGH"
890       }
891     }
892   ],
893   "totalCount": 1.1
894 }

Authentication

x-api-keystring

API Key authentication via header

Path parameters

batchIdstringRequired

Unique Batch Identifier

Query parameters

pageSizedoubleOptional1-100

Page size (default 20)

pagedoubleOptional>=1

Page

Response

consumerUserslist of objects

totalCountdouble

Authentication

Path parameters

Query parameters

Response

Errors