Shortest Path

GET

/v1/shortest_path

GET

1 curl -G https://api.sayari.com/v1/shortest_path \
2      -H "Authorization: Bearer <token>" \
3      --data-urlencode entities=H1y25N5ymnFyZ-q9Lpwm_g&entities=xthsA_jQuKn3GW8-9ILQqg

Play

200Retrieved

1 {
2   "entities": [
3     "H1y25N5ymnFyZ-q9Lpwm_g",
4     "1nOeH5G2EhmRVtmeVqO2Lw"
5   ],
6   "data": [
7     {
8       "source": "H1y25N5ymnFyZ-q9Lpwm_g",
9       "target": {
10         "addresses": [
11           "5TH FLOOR 104 OXFORD STREET, W1D 1LP, LONDON, UNITED KINGDOM",
12           "Oxford Street, London, W1D 1LP",
13           "8 AVENUE RACHEL, 75018, FRANCE"
14         ],
15         "attribute_count": {
16           "name": 1,
17           "identifier": 2,
18           "additional_information": 2,
19           "country": 4,
20           "date_of_birth": 1,
21           "address": 5
22         },
23         "closed": false,
24         "countries": [
25           "FRA",
26           "GBR"
27         ],
28         "degree": 1,
29         "entity_url": "/v1/entity/1nOeH5G2EhmRVtmeVqO2Lw",
30         "id": "1nOeH5G2EhmRVtmeVqO2Lw",
31         "identifiers": [
32           {
33             "value": "053673450003",
34             "type": "uk_person_number",
35             "label": "Uk Person Number"
36           },
37           {
38             "value": "053673450002",
39             "type": "uk_person_number",
40             "label": "Uk Person Number"
41           }
42         ],
43         "label": "Mr Thomas Bangalter",
44         "pep": false,
45         "psa_count": 0,
46         "related_entities_count": 1,
47         "relationship_count": {
48           "registered_agent_of": 1,
49           "shareholder_of": 1,
50           "director_of": 1
51         },
52         "risk": {
53           "basel_aml": {
54             "value": 3.67,
55             "metadata": {
56               "country": [
57                 "GBR"
58               ]
59             },
60             "level": "relevant"
61           },
62           "cpi_score": {
63             "value": 71,
64             "metadata": {
65               "country": [
66                 "FRA"
67               ]
68             },
69             "level": "relevant"
70           }
71         },
72         "sanctioned": false,
73         "source_count": {
74           "4ea8bac1bed868e1510ffd21842e9551": {
75             "count": 28,
76             "label": "UK Persons with Significant Control"
77           },
78           "ecdfb3f2ecc8c3797e77d5795a8066ef": {
79             "count": 17,
80             "label": "UK Corporate Registry"
81           }
82         },
83         "trade_count": {
84           "sent": 0,
85           "received": 0
86         },
87         "type": "person",
88         "user_attribute_count": {},
89         "user_record_count": 0,
90         "user_related_entities_count": 0,
91         "user_relationship_count": {},
92         "date_of_birth": "1975-01",
93         "reference_id": "ecdfb3f2ecc8c3797e77d5795a8066ef/03389614/1540252800000:9030330caf25555c42c0bc0d84ea4aa1"
94       },
95       "path": [
96         {
97           "field": "has_lawyer",
98           "entity": {
99             "addresses": [
100               "Fross Zelnick Lehrman & Zissu, P.C., 866 United Nations Plaza, New York NY 10017",
101               "FROSS ZELNICK LEHRMAN & ZISSU, P.C., 4 TIMES SQUARE, 17TH FLOOR, NEW YORK, NY 10036",
102               "Fross Zelnick Lehrman & Zissu, P.C., 151 West 42nd Street, 17th Floor, New York, NY 10036"
103             ],
104             "attribute_count": {
105               "country": 1,
106               "address": 5,
107               "name": 1
108             },
109             "closed": false,
110             "countries": [
111               "USA"
112             ],
113             "degree": 179,
114             "entity_url": "/v1/entity/xthsA_jQuKn3GW8-9ILQqg",
115             "id": "xthsA_jQuKn3GW8-9ILQqg",
116             "identifiers": [],
117             "label": "LAWRENCE E. APOLZON",
118             "pep": false,
119             "psa_count": 0,
120             "related_entities_count": 179,
121             "relationship_count": {
122               "lawyer_of": 179
123             },
124             "risk": {},
125             "sanctioned": false,
126             "source_count": {
127               "ac1fa195f9cd4ccf657bca3c6db0bb19": {
128                 "count": 199,
129                 "label": "USA Patents and Trademark Office Trademark Applications"
130               }
131             },
132             "trade_count": {
133               "sent": 0,
134               "received": 0
135             },
136             "type": "person",
137             "user_attribute_count": {},
138             "user_record_count": 0,
139             "user_related_entities_count": 0,
140             "user_relationship_count": {},
141             "reference_id": "ac1fa195f9cd4ccf657bca3c6db0bb19/76232419/1717632000000:6d0f0edbd065319df4be58c3bc7909f5"
142           },
143           "relationships": {
144             "has_lawyer": {
145               "values": [
146                 {
147                   "record": "ac1fa195f9cd4ccf657bca3c6db0bb19/76082348/1717632000000",
148                   "attributes": {},
149                   "acquisition_date": "2024-06-06"
150                 }
151               ]
152             }
153           }
154         }
155       ]
156     }
157   ]
158 }

The Shortest Path endpoint returns a response identifying the shortest traversal path connecting each pair of entities.

Query parameters

entitiesstringRequired

A list of Sayari entity IDs specifying the source and target entities for the shortest path calculation. The list must contain exactly two entity IDs The first entity ID represents the source.The second entity ID represents the target.

Response

This endpoint returns an object.

entitieslist of strings

datalist of objects

Shortest Path

Headers

Query parameters

Response

Errors