Users - Search

GET

/users/search

GET

/management/users/search

curl https://sandbox.api.flagright.com/management/users/search \
     -H "x-api-key: <apiKey>"

{
  "items": [
    {
      "userId": "string",
      "createdTimestamp": 2220000000000,
      "activatedTimestamp": 2220000000000,
      "userDetails": {
        "name": {
          "firstName": "Baran",
          "middleName": "Realblood",
          "lastName": "Ozkan"
        },
        "dateOfBirth": "1991-01-01",
        "countryOfResidence": "US",
        "countryOfTaxResidence": "DE",
        "secondaryCountryOfTaxResidence": [
          "US",
          "GB"
        ],
        "countryOfNationality": "DE",
        "secondaryCountryOfNationality": [
          "US",
          "GB"
        ]
      },
      "userStateDetails": {
        "reason": "string",
        "state": "UNACCEPTABLE"
      },
      "kycStatusDetails": {
        "reason": "string",
        "status": "SUCCESSFUL"
      },
      "eoddDate": 2220000000000,
      "employmentStatus": "UNEMPLOYED",
      "occupation": "string",
      "legalDocuments": [
        {
          "documentType": "string",
          "documentNumber": "string",
          "documentIssuedDate": 2220000000000,
          "documentExpirationDate": 2220000000000,
          "documentIssuedCountry": "AF",
          "tags": [
            {
              "key": "string",
              "value": "string",
              "isTimestamp": true
            }
          ],
          "nameOnDocument": {
            "firstName": "Baran",
            "middleName": "Realblood",
            "lastName": "Ozkan"
          },
          "documentIssuedState": "string"
        }
      ],
      "contactDetails": {
        "emailIds": [
          "string"
        ],
        "contactNumbers": [
          "string"
        ],
        "faxNumbers": [
          "string"
        ],
        "websites": [
          "string"
        ],
        "addresses": [
          {
            "addressLines": [
              "string"
            ],
            "postcode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "addressType": "string",
            "tags": [
              {
                "key": "string",
                "value": "string",
                "isTimestamp": true
              }
            ]
          }
        ],
        "name": {
          "firstName": "Baran",
          "middleName": "Realblood",
          "lastName": "Ozkan"
        },
        "tags": [
          {
            "key": "string",
            "value": "string",
            "isTimestamp": true
          }
        ]
      },
      "employmentDetails": {
        "employmentSector": "string",
        "employerName": "string",
        "businessIndustry": [
          "string"
        ]
      },
      "transactionLimits": {
        "maximumDailyTransactionLimit": {
          "amountValue": 800,
          "amountCurrency": "GBP"
        },
        "maximumWeeklyTransactionLimit": {
          "amountValue": 800,
          "amountCurrency": "GBP"
        },
        "maximumMonthlyTransactionLimit": {
          "amountValue": 800,
          "amountCurrency": "GBP"
        },
        "maximumQuarterlyTransactionLimit": {
          "amountValue": 800,
          "amountCurrency": "GBP"
        },
        "maximumTransactionLimit": {
          "amountValue": 800,
          "amountCurrency": "GBP"
        },
        "maximumYearlyTransactionLimit": {
          "amountValue": 800,
          "amountCurrency": "GBP"
        },
        "paymentMethodLimits": {
          "ACH": {
            "transactionCountLimit": {
              "day": 1.1,
              "week": 1.1,
              "month": 1.1,
              "year": 1.1
            },
            "transactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            },
            "averageTransactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            }
          },
          "CARD": {
            "transactionCountLimit": {
              "day": 1.1,
              "week": 1.1,
              "month": 1.1,
              "year": 1.1
            },
            "transactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            },
            "averageTransactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            }
          },
          "IBAN": {
            "transactionCountLimit": {
              "day": 1.1,
              "week": 1.1,
              "month": 1.1,
              "year": 1.1
            },
            "transactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            },
            "averageTransactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            }
          },
          "UPI": {
            "transactionCountLimit": {
              "day": 1.1,
              "week": 1.1,
              "month": 1.1,
              "year": 1.1
            },
            "transactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            },
            "averageTransactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            }
          },
          "GENERIC_BANK_ACCOUNT": {
            "transactionCountLimit": {
              "day": 1.1,
              "week": 1.1,
              "month": 1.1,
              "year": 1.1
            },
            "transactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            },
            "averageTransactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            }
          },
          "MPESA": {
            "transactionCountLimit": {
              "day": 1.1,
              "week": 1.1,
              "month": 1.1,
              "year": 1.1
            },
            "transactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            },
            "averageTransactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            }
          },
          "SWIFT": {
            "transactionCountLimit": {
              "day": 1.1,
              "week": 1.1,
              "month": 1.1,
              "year": 1.1
            },
            "transactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            },
            "averageTransactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            }
          },
          "WALLET": {
            "transactionCountLimit": {
              "day": 1.1,
              "week": 1.1,
              "month": 1.1,
              "year": 1.1
            },
            "transactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            },
            "averageTransactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            }
          },
          "CHECK": {
            "transactionCountLimit": {
              "day": 1.1,
              "week": 1.1,
              "month": 1.1,
              "year": 1.1
            },
            "transactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            },
            "averageTransactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            }
          },
          "CASH": {
            "transactionCountLimit": {
              "day": 1.1,
              "week": 1.1,
              "month": 1.1,
              "year": 1.1
            },
            "transactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            },
            "averageTransactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            }
          },
          "NPP": {
            "transactionCountLimit": {
              "day": 1.1,
              "week": 1.1,
              "month": 1.1,
              "year": 1.1
            },
            "transactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            },
            "averageTransactionAmountLimit": {
              "day": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "week": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "month": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              },
              "year": {
                "amountValue": 800,
                "amountCurrency": "GBP"
              }
            }
          }
        }
      },
      "expectedIncome": {
        "dailyExpectedIncome": {
          "amountValue": 800,
          "amountCurrency": "GBP"
        },
        "weeklyExpectedIncome": {
          "amountValue": 800,
          "amountCurrency": "GBP"
        },
        "monthlyExpectedIncome": {
          "amountValue": 800,
          "amountCurrency": "GBP"
        },
        "quarterlyExpectedIncome": {
          "amountValue": 800,
          "amountCurrency": "GBP"
        },
        "yearlyExpectedIncome": {
          "amountValue": 800,
          "amountCurrency": "GBP"
        }
      },
      "expectedTransactionCountries": {
        "incoming": [
          {
            "countryCode": "AF"
          }
        ],
        "outgoing": [
          {
            "countryCode": "AF"
          }
        ]
      },
      "expectedTransactionCurrencies": {
        "incoming": [
          {
            "currencyCode": "1INCH"
          }
        ],
        "outgoing": [
          {
            "currencyCode": "1INCH"
          }
        ]
      },
      "riskLevel": "VERY_HIGH",
      "kycRiskLevel": "VERY_HIGH",
      "acquisitionChannel": "ORGANIC",
      "reasonForAccountOpening": [
        "string"
      ],
      "sourceOfFunds": [
        "Earnings"
      ],
      "userSegment": "RETAIL",
      "pepStatus": [
        {
          "isPepHit": true,
          "pepCountry": "AF",
          "pepRank": "LEVEL_1",
          "category": "string"
        }
      ],
      "sanctionsStatus": true,
      "adverseMediaStatus": true,
      "corporateEntities": [
        {
          "legalName": "string"
        }
      ],
      "linkedEntities": {
        "parentUserId": "string"
      },
      "savedPaymentDetails": [
        {
          "method": "CARD",
          "cardFingerprint": "20ac00fed8ef913aefb17cfae1097cce",
          "cardIssuedCountry": "TR",
          "transactionReferenceField": "Deposit",
          "3dsDone": true
        }
      ],
      "tags": [
        {
          "key": "string",
          "value": "string",
          "isTimestamp": true,
          "isEditable": true
        }
      ],
      "attachments": [
        {
          "id": "string",
          "comment": "string",
          "files": [
            {
              "s3Key": "string",
              "bucket": "string",
              "filename": "string",
              "size": 1.1,
              "downloadLink": "string",
              "aiSummary": "string"
            }
          ],
          "userId": "string",
          "createdAt": 2220000000000,
          "deletedAt": 2220000000000,
          "tags": [
            "string"
          ]
        }
      ],
      "metaData": {
        "batteryLevel": 1.1,
        "deviceLatitude": 1.1,
        "deviceLongitude": 1.1,
        "ipAddress": "string",
        "ipCountry": "AF",
        "deviceIdentifier": "string",
        "vpnUsed": true,
        "operatingSystem": "string",
        "deviceMaker": "string",
        "deviceModel": "string",
        "deviceYear": "string",
        "appVersion": "string",
        "deviceIntelligenceSealedResult": "string",
        "tor": true,
        "confidence": 0.5,
        "incognito": true,
        "proxy": true,
        "tampering": true,
        "botDetection": "bad",
        "privacySettings": true,
        "suspectScore": 1,
        "velocity5mEvents": 1,
        "velocity5mIps": 1,
        "velocity5mCountries": 1,
        "velocity1hEvents": 1,
        "velocity1hIps": 1,
        "velocity1hCountries": 1,
        "velocity24hEvents": 1,
        "velocity24hIps": 1,
        "velocity24hCountries": 1,
        "requestId": "string",
        "osVersion": "string",
        "browser": "string",
        "browserVersion": "string",
        "rooted": true,
        "jailbroken": true,
        "frida": true,
        "clonedApp": true,
        "emulator": true,
        "simulator": true,
        "developerTools": true,
        "mitmAttack": true,
        "ipAttackSource": true,
        "ipEmailSpam": true,
        "replayed": true,
        "virtualMachine": true,
        "virtualMachineConfidenceScore": 0.5,
        "locationSpoofing": true,
        "factoryResetTimestamp": 1,
        "highActivityDevice": true,
        "rareDevice": true,
        "rareDevicePercentileBucket": "string",
        "vpnConfidence": "string",
        "vpnOriginCountry": "string",
        "vpnOriginTimezone": "string",
        "botType": "string",
        "proxyConfidence": "string",
        "proxyConfidenceScore": 0.5,
        "tamperingConfidence": "string",
        "tamperingConfidenceScore": 0.5,
        "tags": [
          {
            "key": "string",
            "value": "string",
            "isTimestamp": true
          }
        ]
      },
      "jurisdiction": "string",
      "productsEnabled": [
        {
          "productName": "string",
          "details": {
            "account": {
              "accountNumber": "string",
              "openingDate": "string",
              "status": "ACTIVE",
              "tags": [
                {
                  "key": "string",
                  "value": "string",
                  "isTimestamp": true
                }
              ],
              "jointEntity": [
                "string"
              ]
            },
            "loan": {
              "accountNumber": "string",
              "openingDate": "string",
              "status": "ACTIVE",
              "maturityDate": "string",
              "loanAmount": 1.1,
              "disbursedAmount": 1.1,
              "balance": 1.1,
              "tags": [
                {
                  "key": "string",
                  "value": "string",
                  "isTimestamp": true
                }
              ],
              "jointEntity": [
                "string"
              ]
            }
          }
        }
      ],
      "externalLinks": [
        "string"
      ],
      "customObject": {}
    }
  ],
  "hasNext": true,
  "hasPrev": true,
  "next": "string",
  "prev": "string",
  "count": 1,
  "pageSize": 1,
  "last": "string"
}

Users Search

GET /users/search endpoint retrieves a list of users matching the specified search criteria.

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Query parameters

namestringOptional

emailstringOptional

startstringOptional

pageSizeintegerOptional1-100

sortOrderenumOptional

Allowed values:

sortByenumOptional

Allowed values:

Response

itemslist of objectsOptional

hasNextbooleanOptional

hasPrevbooleanOptional

nextstringOptional

prevstringOptional

countintegerOptional

pageSizeintegerOptional

laststringOptional

Errors

400

Bad Request Error