Availability of this service is restricted while in pilot phase.
The service is implemented in form of a monitor system, which is available through a number of different API endpoints.
A brief walkthrough of the integration process:
1) Register the monitor
To be able to subscribe to notifications you must first make a request to create your monitor. Create a new monitor API reference.
An important attribute of the registration request is the webhook url. This is the endpoint where you wish to receive the notifications.
| Parameter | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Webhook | The webhook url is the endpoint where you wish to receive the notifications. | ||||||||
| Name | Name of the monitor | ||||||||
| Template | The template controls what sanction lists the monitor will be connected to.
Note that access to the OFAC list is restricted and requires extra scope. |
2) Add persons to the monitor
Next the collection of individuals of your choice must be added to the monitor. There are different methods for how to populate or manipulate the list, such as batch file upload and POST JSON array.
3) Receive notifications
The service will continuously monitor all registered individuals and trigger alerts whenever a state has changed, for instance if a person has been added to a PEP- or Sanction-list.
Your system will be notified about such alerts through notifications send to the webhook endpoint. Notifications are send out once every night if there are unhandled alerts registered on the monitor. A notification contains information about number of alerts, and what monitor triggered the alerts.
4) Retrieve alerts
A request to the alerts endpoint is responded with a list of all unhandled alerts. Each alerts consists of an ID and details about what attribute on the particular individual triggered the alert.
5) Mark alerts as received
Finally a request must be made to mark the alert as received (stop notifications).
Test simulator
In the test environment, a simulator is available as a test tool. See Continuous screening test simulator.