Initial Screening for Monitored Entities
The monitoring endpoint now supports initial screening when adding entities to a monitor. When enabled, any entity added to a monitor is immediately screened against existing hits in the system using that monitor's configured settings.
How to setup initial screening within your monitor
- Execute initial screen of all entities against your designated lists using POST:/screen_entities
- Set up a notifier using POST:/monitoring/notifier
- Prerequisite: You must have a webhook configured internally to receive alerts
- Test your notifier configuration using POST:/monitoring/notifier/{slug}/test
- A single notifier can be reused across multiple monitors to centralize alert handling
- Create a monitor referencing your notifier using POST:/monitoring/monitor
- Each monitor links to one notifier and defines which lists to screen against
- Set screening parameters such as score thresholds and WeakAKA settings
- You can create multiple monitors with different parameters (e.g., "High-Risk Clients," "PEP Screening," "Sanctions Only")
- Set the initial_screen boolean to true if entities added to a monitor should be screened to any hits already in the system (using the monitor settings), similar to POST :/screen_entity
- Add entities to monitor using POST:/monitoring/monitor/{monitor_slug}/screen_entities
- These are the specific names (people or companies) that will be continuously screened and generate alerts
- Each entity requires a unique provider_id within the monitor
- The same entity can be added to multiple monitors with different screening parameters for tiered monitoring
- If initial_screen is set to true on the parent monitor, a screen of all available hits will be run using the monitor settings whenever a screen_entity screen_entity is added or updated on a monitor
To learn more, read Monitoring Overview