API Reference 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_depthinteger

max_depthinteger

relationshipslist of enums

countrieslist of enums

Country enums are normalized representations of country names. Source

typeslist of strings

namestring

watchlistboolean

psaboolean

offsetinteger

limitinteger

nextboolean

partial_resultsboolean

datalist of objects

explored_countinteger

sanctionedbooleanOptional

pepbooleanOptional

GET

1 curl -G https://api.sayari.com/v1/traversal/mGq1lpuqKssNWTjIokuPeA \
2      -H "Authorization: Bearer <token>" \
3      -d limit=1

200Retrieved

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