GA
Ubo
The UBO endpoint returns paths from a single target entity to up to 50 beneficial owners. The endpoint is a shorthand for the equivalent traversal query.
Path parameters
id
Unique identifier of the entity
Headers
Authorization
OAuth authentication of the form <token>.
Query parameters
limit
Limit total values for traversal. Defaults to 10. Max of 50.
offset
Offset values for traversal. Defaults to 0. Max of 1000.
min_depth
Set minimum depth for traversal. Defaults to 1.
max_depth
Set maximum depth for traversal. Defaults to 4.
relationships
Set relationship type(s) to follow when traversing related entities. Defaults to has_shareholder, has_beneficial_owner, has_partner, subsidiary_of, and branch_of.
psa
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.
countries
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](/sayari-library/ontology/enumerated-types#country).
types
Filter paths to only those that end at an entity of the specified type(s). Defaults to returning paths that end at any type.
sanctioned
Filter paths to only those that end at an entity appearing on a watchlist. Defaults to not filtering paths by sanctioned status.
pep
Filter paths to only those that end at an entity appearing on a pep list. Defaults to not filtering paths by pep status.
exclude_former_relationships
Include relationships that were valid in the past but not at the present time. Defaults to true.
exclude_closed_entities
Include entities that existed in the past but not at the present time. Defaults to false.
risk_categories
Filter paths to only those that relate with an entity that we have flagged with any risk factor of these categories
eu_high_risk_third
Filter paths to only those that relate with an entity that we have flagged with this risk factor
reputational_risk_modern_slavery
Filter paths to only those that relate with an entity that we have flagged with this risk factor
state_owned
Filter paths to only those that relate with an entity that we have flagged with this risk factor
formerly_sanctioned
Filter paths to only those that relate with an entity that we have flagged with this risk factor
reputational_risk_terrorism
Filter paths to only those that relate with an entity that we have flagged with this risk factor
reputational_risk_organized_crime
Filter paths to only those that relate with an entity that we have flagged with this risk factor
reputational_risk_financial_crime
Filter paths to only those that relate with an entity that we have flagged with this risk factor
reputational_risk_bribery_and_corruption
Filter paths to only those that relate with an entity that we have flagged with this risk factor
reputational_risk_other
Filter paths to only those that relate with an entity that we have flagged with this risk factor
reputational_risk_cybercrime
Filter paths to only those that relate with an entity that we have flagged with this risk factor
regulatory_action
Filter paths to only those that relate with an entity that we have flagged with this risk factor
law_enforcement_action
Filter paths to only those that relate with an entity that we have flagged with this risk factor
xinjiang_geospatial
Filter paths to only those that relate with an entity that we have flagged with this risk factor
Response
This endpoint returns an object.
min_depth
max_depth
relationships
countries
types
name
watchlist
psa
offset
limit
next
partial_results
data
explored_count
sanctioned
pep