Views Endpoint
The Views endpoint returns all available watchlist views that your account can screen against. Use this endpoint to discover which list groups are available for use in the list_groups field of your screening configuration.
Endpoint
GET /evaluation/sanctions/views
Authentication
Include your API key and account name in the request headers:
x-api-key: <YOUR API KEY>
Account-Name: <YOUR ACCOUNT NAME>
Request
The Views endpoint accepts a GET request with no query parameters or request body.
- cURL
- Python
curl --location 'https://api.enigma.com/evaluation/sanctions/views' \
--header 'x-api-key: <YOUR API KEY>' \
--header 'Account-Name: <YOUR ACCOUNT NAME>'
import requests
url = "https://api.enigma.com/evaluation/sanctions/views"
headers = {
"x-api-key": "<YOUR API KEY>",
"Account-Name": "<YOUR ACCOUNT NAME>"
}
response = requests.get(url, headers=headers)
views = response.json()
print(views)
Response
The endpoint returns a JSON object containing the available watchlist views. Each view represents a collection of sanctions or watchlist data that can be targeted during screening.
Common Views
| View ID | Description |
|---|---|
pos/sdn/all | OFAC Specially Designated Nationals (SDN) list |
pos/non_sdn/all | OFAC Non-SDN consolidated lists |
enigma/rogues | Enigma curated rogues list |
enigma/testing | Testing list for development and integration |
The views returned by this endpoint may vary depending on your account's configuration and entitlements. Contact your Enigma representative if you need access to additional watchlists.
Using Views in Screening Requests
The view IDs returned by this endpoint correspond to the values used in the list_groups field of your screening configuration. You can specify which views to screen against in two ways:
In the screening request body
Pass list_groups inside configuration_overrides to target specific views for a single request:
{
"configuration_overrides": {
"list_groups": [
"pos/sdn/all",
"pos/non_sdn/all"
]
}
}
In your account configuration
Set default list_groups in your account's screening configuration so that all requests automatically screen against your preferred views. See the Core Screening Endpoints documentation for more details on configuration.
Understanding View IDs in Screening Results
When a screening request returns hits, each matched attribute includes a view_ids field indicating which view(s) the match was found in:
{
"person_name": {
"id": "primary_name",
"score": 0.6708,
"value": "JOHN DESMOND HANAFIN",
"view_ids": ["pos/sdn/all"]
}
}
This allows you to determine exactly which watchlist produced each match, which is useful for compliance reporting and decision-making.