...
The service supports assessment of both individuals (persons)
...
and organizations.
The person resource and the organization resource handles on demand queries of single results, while the continuous screening of persons service (pilot) offers notifications based on continuous monitoring a set of individuals of your choice.
Table of Contents
| Table of Contents | ||
|---|---|---|
|
The person resource
The following dataset is offered in addition to the base identity (Name and SSN) provided by BankID:
...
The organization resource
...
The following dataset is offered:
...
- Company name
- Org number
- DUNS number
- Lei number
- Organization type
- Country
- Registered date
- Webpage
- Employees
- Member of registries
- Sources
Possible
...
additional data that you can choose
To query additional details, a client must declare this explicitly as part of the request by usage of the "expand" parameter. Se API documentation for further details.
...
| Note |
|---|
The following expand arguments are present in the API docs, but they are currently not supported until the associated functionality becomes available in a future release.
|
The continuous screening of persons service (pilot)
| Note |
|---|
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.
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).
API documentation
See separate AML API documentation for technical details about the HTTP API.
...