Returns a list of data objects from PEP and Sanctions services associated with a specific session Id = {id}
Only available for customers using the Veriff PEP and Sanctions services.
For matchTypes, see the data provider's documentation [↗] for more detailed info.
Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.
Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")
Session id signed with the shared secret key
Session id
Watchlist screening data
API request status
Data containing PEP & Sanctions result details
UUID v4 which identifies session attempt
UUID v4 which identifies session
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
Indicates if the response is for the initial check or a subsequent check, one of initial_result or updated_result
Indicates if there was a match in the database, one of possible_match, no_match
Data used to perform the check
Full name used during the check
Birth year used during the check
Total number of hits returned from the check
Timestamp indicating when the check response was received
Array of records that were matched. Empty array if no hits were found
The name that was matched in this hit based on the search term
List of countries that sources listed in relation to this hit
Birth date of the person in the matched listings
Death date of the person in the matched listings
Array that shows the match type in the listings
Array of names that the matched person is also known as
Array of names that the matched person is associated with
Matched listings. Empty object if addon "PEP & Sanctions check" is not enabled
Array of objects
Source name of the related listing
Source URL of the related listing
Date of the related listing
Array of objects
Source name of the related listing
Source URL of the related listing
Date of the related listing
Array of objects
Source name of the related listing
Source URL of the related listing
Date of the related listing
Array of objects
Source name of the related listing
Source URL of the related listing
Date of the related listing
Array of objects
Source name of the related listing
Source URL of the related listing
Date of the related listing
Watchlist screening is in progress
API request status
Tracking URL
Bad request
Unauthorized
Watchlist screening is not enabled
Session not found
Internal server error