Skip to main content

Screening Console Guide

This guide walks you through how to use our customer screening console as an evaluation tool for searching prospective or existing customers for potential matches against US government sanctions lists via our screening API endpoint.

Searches are run against Enigma's "Open Data" source, which currently ingests and indexes all OFAC SDN and non-SDN entities. Our screening endpoint also offers industry-leading transaction screening.

As a client, you can configure our screening endpoint to work with any 3rd party and custom lists of your choosing, as well as any case manager that suits your preference. To learn more about how our screening API endpoint works, please refer to our API Reference.

Getting Started

Create a Console Account

  1. If you do not already have an Enigma Console account, proceed to step 2. If you have an existing account, skip to "Using the Console".

  2. Create an account on our Console.

Screening Console Interface

  1. This takes you to the screening API console. Here, you will see fields and system parameters on the left that you can enter and adjust, and on the right is the corresponding request JSON, which is sent to the screening endpoint to process the request.

Screening API Console

Using the Console

Step 1: Select Entity Type

The first step of a screening search is selecting the entity type - either a person or an organization - and then inputting their name.

Screening Entity Type Selection

Step 2: Enter Additional Details

Enter any further details you have available on the customer being screened. This is optional but the more information provided in the screening request the more precise the results will be.

Person-type screening requests can include:

  • DOB (date of birth)
  • Address
  • Country

Organization-type screening requests can include:

  • Address
  • Country

Screening Address Input

Step 3: Set Relevance Weights

Our screening service allows you to set relevance weights for each attribute included in your request. These weights indicate the degree to which a match on an attribute value contributes to the overall hit score.

If you have low confidence in the accuracy of an attribute (either from your research or from customer input), you may want to lower that attribute's effect on the overall score.

Screening Relevance Weights

Step 4: Configure System Parameters

The evaluation console allows you to alter certain system parameters that influence screening behavior to suit your specific needs and risk tolerance:

ParameterDescription
Alert ThresholdScore (0-1) above which a hit triggers an alert
Hit ThresholdMinimum score (0-1) for a result to be considered a hit
Max ResultsMaximum number of underlying hits to consider
List SourceWhich watchlists to screen against
Overrides ToggleWhether to apply custom override rules
Trial Limitations

In trial mode, the list source is limited to Open Data (OFAC SDN and non-SDN lists). As a client, you can specify any number of 3rd party or custom lists. The overrides toggle doesn't point to any active rules in trial mode.

Screening Results

When you are done entering all entity details and adjusting parameters, click Search to submit your request to the screening endpoint.

Understanding Results

Results Summary

The top of the response page summarizes the results:

  • Alert status: Whether any hits were above the alert threshold
  • Total hits: Number of results above the hit threshold
  • Cleared percentage: Percentage of hits below the alert threshold

Screening Results Summary

Hits Table

Below the summary is a table of all hits, ranked by overall score. The overall score is calculated using the weighted average of matching attribute sub-scores.

  • Red text: Hits that scored above the alert threshold
  • Blue columns: Attribute sub-scores for each searched attribute
  • Dashes (-): No match for that attribute (score = 0)

Screening Result Hits

Entity Details

Click the blue link under the Entity ID column to view the full entity profile, showing all sourced data on that entity.

Screening Entity Profile

Response JSON

Toggle Show Response Code to view the raw JSON response from the screening endpoint. This helps you understand how to integrate with the API programmatically.

Screening JSON Response

Additional API Capabilities

Beyond the console functionality, the API provides additional endpoints:

CapabilityDescription
Configuration ManagementCreate, update, rollback, freeze/unfreeze configurations
Decision ManagementRetrieve and update screening decisions for case management
Batch ProcessingUpload Excel files for high-volume screening
Rate LimitsMonitor API usage and rate limit status

Learn More

For more information on our Customer and Transaction Screening endpoint, integration, and pricing, please contact our sales team.