Watchlist Results - API Comparison

With the availability of Comprehensive and Basic watchlist screening options, customers will need to review their API responses for watchlists results. Please use the comparison table below for more information about the change and review associated sample responses.

	Standard	Premium	Comprehensive (Compliance Platform)	Comprehensive (Comply Advantage)	Basic
Watchlist Result Structure	Each watchlist result is within a separate ‘individualResult’ section.	Each watchlist result is within a separate ‘individualResult’ section.	All watchlist results are in a single ‘individualResult’ section.	All watchlist results are in a single ‘individualResult’ section.	All watchlist results are in a single ‘individualResult’ container.
Watchlists Reported	Includes a specific set of lists (11) that are always checked and a ‘FOUND_ON_LIST’ or ‘NOT_FOUND_LIST’ result is reported in the response for each list.	Includes ‘NOT_FOUND_ON_LIST’ or ‘MATCH_REVIEW_REQUIRED’ result for each watchlist category (PEP, ePEP and Sanctions).	The results are dynamic and will only report on matched watchlists with a ‘FOUND_ON_LIST’ result. 'NOT_FOUND_ON_LIST' when there are no watchlist matches.	The results are dynamic and will only report on matched watchlists with a ‘FOUND_ON_LIST’ or ‘MATCH_REVIEW_REQUIRED’ for each result (depending on configuration). 'NOT_FOUND_ON_LIST' when there are no watchlist matches.	The results are dynamic and will only report on matched watchlists with a ‘FOUND_ON_LIST’ result. 'NOT_FOUND_ON_LIST' when there are no watchlist matches.
Overall Watchlists Result	No overall ‘Watchlists’ result - only individual list results.	No overall ‘Watchlists’ result - only category results. If a match is achieved on Sanctions Lists, each list is included within the 'Individual Result' section.	Includes an overall ‘Watchlists’ result and individual lists results.	Includes an overall ‘Watchlists’ result and individual lists results.	Includes an overall ‘Watchlists’ result and individual lists results.
Reference ID	No reference ID - this capability doesn’t need a reference ID as all checks happen within greenID.	No reference ID - this capability doesn’t need a reference ID as all checks happen within greenID.	Includes a reference ID in extraData - compliancePlatformTransactionID which is the ID of the record in Compliance Platform. This is to facilitate identifying the record in Compliance Platform for case management. This will typically be the same as the verificationID in greenID.	Includes the following in extra data for the full result: a reference ID in ComplyAdvantageCustomerID which is the ID of the record in Comply Advantage. This is to facilitate identifying the record in the supplier’s platform. This will typically be the same as the verificationID in greenID and pre-fixed with the greenID account ID. NumberOfProfilesMatched - to help form a view of number of matches For each watchlist match results - the following is also available in extraData: Category of match (PEP, Associates, Sanctions, AdverseMedia, WarningsAndOtherLists) Associate type for associates Note: This is a summary result. A fuller result is available via getWatchlistResult which is an endpoint which will retrieve the full detailed result.	No reference ID in the API response as this offering does not include case management in Compliance Platform.
API Versions			Supported on v1, v2, v3 and v4 Note: As v1 does not support extraData, the transactionID is not reported to customers.	Supported on v1, v2, v3, v4 & v5. Note: As v1 does not support extraData, the transactionID is not reported to customers.	Supported on v1, v2, v3 and v4
Samples					To be added (Results will be similar to Comprehensive without the transactionID in extra data)