/v1/sessions/{id}/watchlist-screening

Prev Next
Patch
/v1/sessions/{id}/watchlist-screening

Disables the ongoing monitoring feature for a certain end-user (identified by session Id = {id})

Only available for customers using the Veriff PEP and Sanctions services.

If you need to check if the ongoing monitoring is enabled for a particular end-user, check the monitorStatus parameter in GET /watchlist-screening response payload.


Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.



Security
API Key: api_key
Header parameter namex-auth-client

Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")

Header parameters
x-hmac-signature
stringRequired

Request body signed with the shared secret key

Path parameters
id
stringRequired

Session id

Body parameters

Watchlist screening data

object
monitorStatus
string Required

New status of the watchlist screening

Exampledisabled
Responses
200

Disabled watchlist screening successfully

Headers
x-auth-client
string
Your integration's API key. Required to identify the request or response sender. Occasionally referred to as the "API token".
x-hmac-signature
string
Response body signed with the shared secret key. Required to authenticate the response sender.
Expand All
object
status
string

API request status

data
object

Details about watchlist disabling status

attemptId
string (uuid)

UUID v4 which identifies session attempt

Exampleaea9ba6d-1b47-47fc-a4fc-f72b6d3584a7
sessionId
string (uuid)

UUID v4 which identifies session

Examplef04bdb47-d3be-4b28-b028-a652feb060b5
vendorData
string

The unique identifier that you created for your end-user. It can be max 1,000 characters long and contain only non-semantic data that can not be resolved or used outside your systems or environments. Veriff returns it unmodified in webhooks and API response payloads, or as null if not provided

Example1234567890
monitorStatus
string

Indicates if monitoring is enabled or disabled for this session, one of enabled or disabled, or empty if status is unknown

Valid values[ "enabled", "disabled" ]
Exampleenabled
400

Watchlist screening is already disabled

object
status
string

API request status

message
string

Details about the error while disabling watchlist response

401

Unauthorized

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleMandatory X-AUTH-CLIENT header containing the API key is missing from the request.
402

Watchlist screening is not enabled

404

Session not found

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleResource not found
500

Internal server error

object
status
string

API request status

message
string

Details about the error while disabling watchlist response



Document Versioning

Article Versioning

Date

Description

Jan 9, 2026

Documentation published