Compliance Lists

Screen Compliance Lists

Use this endpoint to find fuzzy candidate matches when searching in sanctions and watchlist

SecurityapiKey
Request
Request Body schema: application/json
object (ComplianceListsScreeningConfigurationRequest)

Configuration that should be used during screening. If this object and configurationId are not provided screening will try to use configuration attached to the API Key. In this case if no configuration is attached to the API Key, exception will be thrown. If this object and configurationId are both provided, exception will be also thrown as only on of them is allowed.

configurationId
string (ComplianceListsScreeningConfigurationId)

ID of the configuration that should be used during screening. If not provided screening will try to use configuration attached to the API Key. In this case if no configuration is attached to the API Key, exception will be thrown.

Array of objects (ComplianceDataSource)
object (ComplianceEntryRequest)
limit
integer
Default: 10

Specify the number of returned screen results

startAfter
string (StartAfter)

The ID which is used to read the page.

withAuditTrail
boolean
Default: true

Specifies if audit trail is supposed to be generated in a response

withStopWords
boolean
Default: true

Specifies if stop words are supposed to be detected and special calculation is supposed to be used for matching score

Responses
200

OK

post/v2/compliancelists/screen
Request samples
application/json
{
  • "entry": {
    },
  • "dataSources": [
    ],
  • "lists": [
    ]
}
Response samples
application/json
{
  • "total": "67",
  • "nextStartAfter": "5712566172571652",
  • "startAfter": "5712566172571652",
  • "values": [
    ],
  • "auditTrail": {
    }
}