For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LearnGraph LoginRequest a Demo
HomeAPIBulk DataSayari LibraryChange Log
  • Key Concepts
    • Introduction
    • Endpoint Overview
    • Authentication
    • Requests
    • Pagination
    • Response Status Codes
    • Data Types
    • Rate Limits
  • API Clients
    • Overview
    • Open API
    • Postman
    • Go
    • Python
    • Node
  • API Reference
      • GETTraversal
      • GETUbo
      • GETOwnership
      • GETWatchlist
      • GETShortest Path
  • Guides
    • Getting Started
    • Understanding Project Entity
    • Risk Factors
    • Entity Search
    • Advanced Entity Search
    • Resolution
    • Trade Search - Shipments
    • Trade Search - Suppliers & Buyers
    • v0 Migration
  • Implementation Patterns
    • Project Entity Supply Chain
  • Use Cases
    • Entity Screening & Verification
    • Investigations
LogoLogo
LearnGraph LoginRequest a Demo
API ReferenceTraversal

Shortest Path

GET
/v1/shortest_path
GET
/v1/shortest_path
$curl -G https://api.sayari.com/v1/shortest_path \
>     -H "Authorization: Bearer <token>" \
>     -d entities=H1y25N5ymnFyZ-q9Lpwm_g \
>     -d entities=xthsA_jQuKn3GW8-9ILQqg
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        "logistics_entity": false,
94        "reference_id": "ecdfb3f2ecc8c3797e77d5795a8066ef/03389614/1540252800000:9030330caf25555c42c0bc0d84ea4aa1"
95      },
96      "path": [
97        {
98          "field": "has_lawyer",
99          "entity": {
100            "addresses": [
101              "Fross Zelnick Lehrman & Zissu, P.C., 866 United Nations Plaza, New York NY 10017",
102              "FROSS ZELNICK LEHRMAN & ZISSU, P.C., 4 TIMES SQUARE, 17TH FLOOR, NEW YORK, NY 10036",
103              "Fross Zelnick Lehrman & Zissu, P.C., 151 West 42nd Street, 17th Floor, New York, NY 10036"
104            ],
105            "attribute_count": {
106              "country": 1,
107              "address": 5,
108              "name": 1
109            },
110            "closed": false,
111            "countries": [
112              "USA"
113            ],
114            "degree": 179,
115            "entity_url": "/v1/entity/xthsA_jQuKn3GW8-9ILQqg",
116            "id": "xthsA_jQuKn3GW8-9ILQqg",
117            "identifiers": [],
118            "label": "LAWRENCE E. APOLZON",
119            "pep": false,
120            "psa_count": 0,
121            "related_entities_count": 179,
122            "relationship_count": {
123              "lawyer_of": 179
124            },
125            "risk": {},
126            "sanctioned": false,
127            "source_count": {
128              "ac1fa195f9cd4ccf657bca3c6db0bb19": {
129                "count": 199,
130                "label": "USA Patents and Trademark Office Trademark Applications"
131              }
132            },
133            "trade_count": {
134              "sent": 0,
135              "received": 0
136            },
137            "type": "person",
138            "user_attribute_count": {},
139            "user_record_count": 0,
140            "user_related_entities_count": 0,
141            "user_relationship_count": {},
142            "logistics_entity": false,
143            "reference_id": "ac1fa195f9cd4ccf657bca3c6db0bb19/76232419/1717632000000:6d0f0edbd065319df4be58c3bc7909f5"
144          },
145          "relationships": {
146            "has_lawyer": {
147              "values": [
148                {
149                  "record": "ac1fa195f9cd4ccf657bca3c6db0bb19/76082348/1717632000000",
150                  "attributes": {},
151                  "acquisition_date": "2024-06-06"
152                }
153              ]
154            }
155          }
156        }
157      ]
158    }
159  ]
160}
The Shortest Path endpoint returns a response identifying the shortest traversal path connecting each pair of entities.
Was this page helpful?
Previous

Upstream Trade Traversal

Next
Built with

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

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

Errors

400
Bad Request
401
Unauthorized
404
Not Found
405
Method Not Allowed
429
Rate Limit Exceeded
500
Internal Server Error
502
Bad Gateway
520
Connection Error