Monitor a screening
Puts a screening under continuous monitoring for one year. While it is active, the subject is screened again whenever a sanctions or PEP list adds or changes an entry that could match its name, against that entry only. A new match is recorded once as an alert and sent as a screening.monitoring_alert webhook. Nothing is re-screened on a schedule: the check runs when a list changes.
Before it starts, the subject is screened once against the full lists: a match the screening did not report (a list changed since) is alerted right away, the same way.
Calling it on an active monitoring adds one more year to where it ends. Each call is charged; send an Idempotency-Key (with an empty JSON object {} as the body) to retry safely without a second charge.
Only person and business screenings can be monitored. A customer_id screening is 422 FEATURE_NOT_AVAILABLE (OZAV re-screens its customers on its own), and the charge is refunded.
Request
- Base URLhttps://developers.ozav.io/v2
- Auth
- API key in header X-API-Key
- or HTTP bearer
Path parameters
The opaque screening id (ozav_scr_...).
Headers
Optional idempotency key (16-256 characters of [A-Za-z0-9_-]); same semantics as on money-moving operations.
Response
The monitoring of the screening.
Changes
No recorded changes to this operation across all 1 revision of this API.