Traversal

Traversal

GET

The Traversal endpoint returns paths from a single target entity to up to 50 directly or indirectly-related entities. Each path includes information on the 0 to 10 intermediary entities, as well as their connecting relationships. The response’s explored_count field indicates the size of the graph subset the application searched. Running a traversal on a highly connected entity with a restrictive set of argument filters and a high max depth will require the application to explore a higher number of traversal paths, which may affect performance. In cases where a traversal searches over a very large, highly-connected subgraph, a partial result set may be returned containing only the most relevant results. This will be indicated in the response by the partial_results field.

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 all relationship types.
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 true.
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
reputational_risk_bribery_and_corruptionbooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor
reputational_risk_otherbooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor
reputational_risk_cybercrimebooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor
regulatory_actionbooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor
law_enforcement_actionbooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor
xinjiang_geospatialbooleanOptional
Filter paths to only those that entity with an entity that we have flagged with this risk factor

Response

This endpoint returns an object
min_depth
integer
max_depth
integer
relationships
list of enums
countries
list of enums

Country enums are normalized representations of country names. Source

types
list of strings
name
string
watchlist
boolean
psa
boolean
offset
integer
limit
integer
next
boolean
partial_results
boolean
data
list of objects
explored_count
integer
sanctioned
booleanOptional
pep
booleanOptional
GET
1curl -G https://api.sayari.com/v1/traversal/mGq1lpuqKssNWTjIokuPeA \
2     -H "Authorization: Bearer <token>" \
3     -d limit=1
200
Retrieved
1{
2  "min_depth": 1,
3  "max_depth": 4,
4  "relationships": [],
5  "countries": [],
6  "types": [],
7  "name": "",
8  "watchlist": false,
9  "psa": true,
10  "offset": 0,
11  "limit": 1,
12  "next": true,
13  "partial_results": false,
14  "data": [
15    {
16      "source": "mGq1lpuqKssNWTjIokuPeA",
17      "target": {
18        "addresses": [
19          "202 HAMMERSMITH ROAD UNITED KINGDOM",
20          "202 HAMMERSMITH ROAD BRITISH ISLES"
21        ],
22        "attribute_count": {
23          "name": 1,
24          "address": 2,
25          "country": 2
26        },
27        "closed": false,
28        "countries": [
29          "USA",
30          "GBR"
31        ],
32        "degree": 1,
33        "entity_url": "/v1/entity/puXgX-Swu-Z8bCMW2_FSdQ",
34        "id": "puXgX-Swu-Z8bCMW2_FSdQ",
35        "identifiers": [],
36        "label": "MARIE LEBLANC",
37        "pep": false,
38        "psa_count": 0,
39        "related_entities_count": 1,
40        "relationship_count": {
41          "officer_of": 1
42        },
43        "risk": {
44          "basel_aml": {
45            "value": 3.99,
46            "metadata": {
47              "country": [
48                "GBR"
49              ]
50            },
51            "level": "relevant"
52          },
53          "cpi_score": {
54            "value": 78,
55            "metadata": {
56              "country": [
57                "GBR"
58              ]
59            },
60            "level": "relevant"
61          }
62        },
63        "sanctioned": false,
64        "source_count": {
65          "a447a7b622c4ead6e1caf94983dc2337": {
66            "count": 6,
67            "label": "USA California Secretary of State"
68          }
69        },
70        "trade_count": {
71          "sent": 0,
72          "received": 0
73        },
74        "type": "person",
75        "user_attribute_count": {},
76        "user_record_count": 0,
77        "user_related_entities_count": 0,
78        "user_relationship_count": {},
79        "reference_id": "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1649116800000:0ce01cbfaa586fcfb82164f0e5a010d5"
80      },
81      "path": [
82        {
83          "field": "has_officer",
84          "entity": {
85            "addresses": [
86              "202 HAMMERSMITH ROAD UNITED KINGDOM",
87              "202 HAMMERSMITH ROAD BRITISH ISLES"
88            ],
89            "attribute_count": {
90              "name": 1,
91              "address": 2,
92              "country": 2
93            },
94            "closed": false,
95            "countries": [
96              "USA",
97              "GBR"
98            ],
99            "degree": 1,
100            "entity_url": "/v1/entity/puXgX-Swu-Z8bCMW2_FSdQ",
101            "id": "puXgX-Swu-Z8bCMW2_FSdQ",
102            "identifiers": [],
103            "label": "MARIE LEBLANC",
104            "pep": false,
105            "psa_count": 0,
106            "related_entities_count": 1,
107            "relationship_count": {
108              "officer_of": 1
109            },
110            "risk": {
111              "basel_aml": {
112                "value": 3.99,
113                "metadata": {
114                  "country": [
115                    "GBR"
116                  ]
117                },
118                "level": "relevant"
119              },
120              "cpi_score": {
121                "value": 78,
122                "metadata": {
123                  "country": [
124                    "GBR"
125                  ]
126                },
127                "level": "relevant"
128              }
129            },
130            "sanctioned": false,
131            "source_count": {
132              "a447a7b622c4ead6e1caf94983dc2337": {
133                "count": 6,
134                "label": "USA California Secretary of State"
135              }
136            },
137            "trade_count": {
138              "sent": 0,
139              "received": 0
140            },
141            "type": "person",
142            "user_attribute_count": {},
143            "user_record_count": 0,
144            "user_related_entities_count": 0,
145            "user_relationship_count": {},
146            "reference_id": "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1649116800000:0ce01cbfaa586fcfb82164f0e5a010d5"
147          },
148          "relationships": {
149            "has_officer": {
150              "values": [
151                {
152                  "record": "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1649116800000",
153                  "attributes": {
154                    "position": [
155                      {
156                        "value": "Chief Executive Officer"
157                      }
158                    ]
159                  },
160                  "acquisition_date": "2022-04-05"
161                },
162                {
163                  "record": "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1678752000000",
164                  "attributes": {},
165                  "acquisition_date": "2023-03-14"
166                },
167                {
168                  "record": "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1685664000000",
169                  "attributes": {},
170                  "acquisition_date": "2023-06-02"
171                },
172                {
173                  "record": "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1693872000000",
174                  "attributes": {},
175                  "acquisition_date": "2023-09-05"
176                },
177                {
178                  "record": "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1701648000000",
179                  "attributes": {},
180                  "acquisition_date": "2023-12-04"
181                },
182                {
183                  "record": "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1709769600000",
184                  "attributes": {},
185                  "acquisition_date": "2024-03-07"
186                }
187              ],
188              "last_observed": "2024-03-07"
189            }
190          }
191        }
192      ]
193    }
194  ],
195  "explored_count": 9999999
196}
Built with