Client lists

Create your own lists of information to block, allow, or review matching applicants or transactions.

With client lists, you can manage flexible sets of keys to create verification flows and transaction monitoring rules, blocklist or whitelist applicants, manage workflows in Workflow builder, and many others.

How client lists work

Lists can be categorized based on their purpose and type:

  • Lists by type:
    • Keys. Refers to the trigger configured in the applicant workflow, such as the country, age, or previous verification results. Applicants with defined keys will be processed in accordance with the list type. Mind that key-based list types are only available if the applicant flow is enabled and configured.
    • Applicant IDs. Include 24-character alphanumeric Sumsub applicant IDs.
    • Emails. Include email addresses.
    • Fingerprints. Include unique blockchain identifiers or device distinctive marks.
    • IP Ranges. Include applicants' IP addresses. Data for this type must be added in CIDR format.
  • Lists by purpose:
    • Custom lists — multipurpose lists for exclusive or duplicate profiles.
    • Blocklists — for applicants to be blocked within your project.
    • Whitelists — for applicants that cannot be blocklisted within your project.

The key type and purpose you select will be used to create a unique identifier for the list.

Each time you create a transaction monitoring rule or verification flow, you can use items from client lists as triggers for auto-decline, switching between verification levels, delegation, and many other.

📘

Note

If the Advanced IP check is enabled for your applicants and their IP address is in the IP Ranges list, it might be automatically marked as High risk or Low risk. For more information, see this article.

Default lists

Sumsub offers the following ready-made empty lists that allow you to either block or allow certain actions:

  • Dangerous BTC wallets. A Bitcoin wallet address is a combination of letters and numbers used to perform Bitcoin transactions.
  • Dangerous currencies. Money launderers often use cryptocurrencies to buy Credit, Virtual Chips, or In-Game Currency and cash it after a couple of transactions. So you can create a rule that would put transactions involving assets from your list on hold and assign a human expert to review these.
  • Risky payment details. Some payment methods are more vulnerable in terms of fraud than others. Creating a list of the ones you want to double-check will help you reduce chargebacks while keeping the friction low.

Custom lists

You can create your own lists that contain items of a specific type of information, such as:

  • Lists of custom keys — string-based or key-based lists that can contain case-sensitive strings, Card BINs, country names (specified in ISO 3166-1 alpha-3 format), and so on.
  • Applicant ID lists that include 24-character alphanumeric Sumsub applicant IDs.
  • Email lists that include email addresses.
  • Device fingerprints lists that include unique blockchain identifiers.
  • IP ranges that include IP addresses (specified in CIDR format).

These lists can be used to automatically reject any activities for a specific group of applicants (blocklists), to create groups of applicants that cannot be blocklisted (whitelists), or for any other purpose you can think of (custom).

Create list

To create a new list:

  1. In the Dashboard, go to the Client lists page.
  2. Click Create list and provide a list title and optional description.
  3. Select a key type to be used as a trigger and choose a list type.
  4. Click Create.
  5. Populate your list by entering a reference key, depending on the list type. For example, an applicant ID, email address, and so on.

📘

Note

After creating a list, you cannot change its Type or Entry type. You can only update the description for custom lists. To add or edit the description, click the Edit list (pencil icon). If the Edit button is not available, the list is a default one and cannot be modified.

Create High Risk Countries list

  1. Click Create list on the Client lists page.
  2. Enter a list title, for example, High Risk Countries, and an optional description.
  3. From the Entry type dropdown list, select Keys.
  4. Click Create. After you create it, the list will appear on the Client lists page.
  5. Click on the list title to open it.
  6. Click Create item and provide a country that should be considered risky using the following format:
    1. Set the Key as the country’s Alpha-3 code (for example, DEU, GBR, ARE). The system matches only this format.
    2. Add a Description with the country name or any helpful information.
  7. Use the Import list button to upload a CSV file with multiple countries instead of adding them manually.

You can implement the created list in your verification flow or transaction monitoring rules by setting up a condition to apply country-specific logic and block transactions originating from those countries.

Manage lists

You can manage lists as follows:

  • Import lists. Lets you import an existing list from a CSV file.

📘

Note

When uploading a file, choose either a comma or a semicolon as the separator type. If there is more than one separator in a line, the remaining columns will be ignored.

  • Edit list description. Lets you adjust your existing list description.
  • Remove any list that you have configured previously. Lets you declutter your environment by removing lists that are no longer in use.
No code