Real-Time Watchlist Screening

The Real-Time Watchlist Screening API supports screening party and payment information against lists of known or suspected parties that are involved in illegal activities, such as money laundering, terrorism financing, or other criminal behaviors.

Root

Contains operations for the root resource.

get

Get the list of watchlist screening resources

Internal-Use OnlyReturns the watchlist screening resources.

Screening

Contains the operations to screen named entities against a collection of watchlists.

post

Screen a group of entities

Internal-Use OnlyPerforms a screening action on a list of entities.

/entity

post

Screen a group of payments

Internal-Use OnlyPerforms a screening action on a list of payments.

/payment

Presets

Contains the operations to create, read, update, and delete presets and channels. Presets are predefined options that control screening requests.

get

Screening Exceptions

Contains the operations to create, read, update, and delete screening exceptions. Screening exceptions identify the profiles or conditions that, when matched, do not generate a hit during the screening process.

get

Get a list of screening exceptions

Internal-Use OnlyReturns a list of screening exceptions.

/exceptions

post

Create a new screening exception

Internal-Use OnlyCreates a new screening exception.

/exceptions

get

Get a screening exception by its ID

Internal-Use OnlyReturns a screening exception by its ID.

/exceptions/{screeningExceptionId}

put

Update a screening exception by its ID

Internal-Use OnlyUpdates the specified screening exception. Only conditional exceptions can be updated, since profile exceptions do not contain any fields that are mutable after they are created.

/exceptions/{screeningExceptionId}

delete

Delete a screening exception by its ID

Internal-Use OnlyDeletes the specified screening exception.

/exceptions/{screeningExceptionId}

Watchlist Profiles

Contains the operation to read watchlist profiles. A watchlist profile represents the publication of data on a sanctioned entity or individual by a given watchlist. A specific version of a watchlist profile is identified by the unique pairing of its profile ID and checksum.

get

Get a watchlist profile by its profile ID and checksum

Internal-Use OnlyReturns the requested watchlist profile data.

/profiles/{profileId}

Watchlist Metadata

Contains the operations to read watchlist metadata. The watchlist metadata contains information about a watchlist including its sanction codes and categories.

get