Big ID Integration


The scan tool is packaged as a docker image. This guide assumes that you have docker installed, and are running the scan tool BigID app on Linux.


1. Extract the archive to a separate folder

2. Enter the archive directory

3. Load docker image from file

docker load -i ./bigid-sanctions.tar

4. Place your SSL credentials (chain.pem, fullchain.pem, privkey.pem – if using LetsEncrypt) into the ./src/secrets folder

5. Run the app

PORT=3000 SECRETS_DIR=./src/secrets docker-compose -f ./docker-compose.yml up --detach

You may adjust the PORT and SECRETS_DIR directory accordingly

6. Log into your BigID instance

7. In the Applications Management page, click ‘Add App’

8. Enter the URL of the machine running the scan tool into the Application Base URL prompt, adding the port number if necessary

Example: <a href=""></a><br>

9. With the app installed, scroll down to the General Parameters section

1.Enter your API key – this will be needed to download the sanctions listings

2.Enter your desired upper threshold for Levenshtein distance as a positive integer. During the matching stage, matches between names found in your entity database and in the sanctions listing will be recorded if the Levenshtein distance between both names is equal to or less than this value

10.Click ‘Save’ to save your entered data.


Clearing BigID Correlation Sets & Data Source Scans prior to use

Our App creates Correlation Sets and Data Source Scans on your BigID instance in order to scan your data against known sanctioned entities & individuals. These need to be cleared prior to subsequent use of the app.

1. Visit ‘Correlation Sets’ under the Administration tab 

2. Select all Correlation Sets with “Sanctions_CS” in the name and delete them 

3. Visit ‘Scans’ under the Administration tab 

4.Under “Scan Profiles”, find the Scan Profile named “ Data Source Scan” and delete it 

Conducting a scan

If you should encounter any error with the following steps or would like to start again, just refresh the page. You may need to remove existing Correlation Sets and Data Source Scans (as described above).

1.Visit the App. You will be presented with the first page. Tabs on the left will guide you through the process of defining your data location and conducting a scan.

Step 1 – Launch

1.Click the ‘Initiate Setup’ button. This will load available data sources 

Step 2 – Select Data Source(s)  

1.For each data source you wish to scan, choose: 

a) The name of the data source from the dropdownb) The name of the table / object nameTo add additional data sources, click the ‘add new data source’ button

Step 3 – Select Columns 

1.For each data source:

a) Identity the primary key column – this can be any column with a unique value (typically the primary key)b) Click the ‘Select’ button to confirm your selectionc) Identify the column with name data from the remaining columns – this is the column of the table that contains names that you wish to scan against the sanctions database

2.Once you are done, click ‘submit’ at the bottom of the page. This will create the necessary Correlation Scans

Step 4 – Create Scan Profile

1.Click the ‘Create’ button. This will create the necessary Scan Profile.

Step 5 – Run Scan

1.Click the ‘Run’ button. This will run the data source scan

Step 6 – Run Matching

1. Proceed to the Actions page and click Run on both the ‘Download PII Data’ and ‘Download Sanctions Data’ actions. This is needed before this step can be run.Note that there will be no user feedback immediately after clicking ‘Run’. Once the data is downloaded, there will be a green popup in the top right of the window

2. Return to the UI page (Run matching tab) and Click the ‘Scan’ Button. This will scan the sanctions database and allow you to filter for sanctions data sources. You may leave this blank to scan the entire sanctions database or select one or more data sources to filter.

3. Click ‘Run’ to run the matching process. This will match your data against the sanctions database and return hits.

1. Note that having a Levenshtein distance that is too high will return too many false positives. Too low of a value will return too few hits or none at all. Adjust this value according to how close you require matches to be.2. Scans run are not guaranteed to be exhaustive. As the scan is conducted not against your data directly, but against BigID entities – any source data that is missed during the BigID data source scan will not be matched.

Step 7 – Results

1. The results page shows potential matches

2. Click the ‘+’ icon to see additional information about a potential match. Information pertaining to your data (the BigID entity) is on the left. Information pertaining to the sanctioned individual / entity is on the right.

3. Potential matches are based on a comparison of names using Levenshtein distance. If a primary name or alternate name triggers a match based on this criteria – it will be in bold


To uninstall the app:

1. Remove the created correlation set (ending in ‘Sanctions_CS’)2. Remove the created Scan Profile ( Data Source Scan)

2. On the App page – click the options button in the top right and click ‘Delete App’

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us