The Watchlist endpoint returns paths from a single target entity to up to 50 other entities that appear on a watchlist. The endpoint is a shorthand for the equivalent traversal query.
Path parameters
idstringRequired
Unique identifier of the entity
Query parameters
limitintegerOptional
Limit total values for traversal. Defaults to 10. Max of 50.
offsetintegerOptional
Offset values for traversal. Defaults to 0. Max of 1000.
min_depthintegerOptional
Set minimum depth for traversal. Defaults to 1.
max_depthintegerOptional
Set maximum depth for traversal. Defaults to 4.
relationshipsenumOptional
Set relationship type(s) to follow when traversing related entities. Defaults to following 31 relevant relationship types covering ownership, control, and trade.
psabooleanOptional
Also traverse relationships from entities that are possibly the same as any entity that appears in the path. Defaults to traversing possibly same as relationships.
countriesenumOptional
Filter paths to only those that end at an entity associated with the specified country(ies). Defaults to returning paths that end in any country.
typesenumOptional
Filter paths to only those that end at an entity of the specified type(s). Defaults to returning paths that end at any type.
sanctionedbooleanOptional
Filter paths to only those that end at an entity appearing on a watchlist. Defaults to not filtering paths by sanctioned status.
pepbooleanOptional
Filter paths to only those that end at an entity appearing on a pep list. Defaults to not filtering paths by pep status.
min_sharesintegerOptional
Set minimum percentage of share ownership for traversal. Defaults to 0.
include_unknown_sharesbooleanOptional
Also traverse relationships when share percentages are unknown. Only useful when min_shares is set greater than 0. Defaults to true.
exclude_former_relationshipsbooleanOptional
Include relationships that were valid in the past but not at the present time. Defaults to false.
exclude_closed_entitiesbooleanOptional
Include entities that existed in the past but not at the present time. Defaults to false.
eu_high_risk_thirdbooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor
reputational_risk_modern_slaverybooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor
state_ownedbooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor
formerly_sanctionedbooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor
reputational_risk_terrorismbooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor
reputational_risk_organized_crimebooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor
reputational_risk_financial_crimebooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor