Shortest Path | Sayari

curl -G https://api.sayari.com/v1/shortest_path \
     -H "Authorization: Bearer <token>" \
     -d entities=H1y25N5ymnFyZ-q9Lpwm_g \
     -d entities=xthsA_jQuKn3GW8-9ILQqg

{
  "entities": [
    "H1y25N5ymnFyZ-q9Lpwm_g",
    "1nOeH5G2EhmRVtmeVqO2Lw"
  ],
  "data": [
    {
      "source": "H1y25N5ymnFyZ-q9Lpwm_g",
      "target": {
        "addresses": [
          "5TH FLOOR 104 OXFORD STREET, W1D 1LP, LONDON, UNITED KINGDOM",
          "Oxford Street, London, W1D 1LP",
          "8 AVENUE RACHEL, 75018, FRANCE"
        ],
        "attribute_count": {
          "name": 1,
          "identifier": 2,
          "additional_information": 2,
          "country": 4,
          "date_of_birth": 1,
          "address": 5
        },
        "closed": false,
        "countries": [
          "FRA",
          "GBR"
        ],
        "degree": 1,
        "entity_url": "/v1/entity/1nOeH5G2EhmRVtmeVqO2Lw",
        "id": "1nOeH5G2EhmRVtmeVqO2Lw",
        "identifiers": [
          {
            "value": "053673450003",
            "type": "uk_person_number",
            "label": "Uk Person Number"
          },
          {
            "value": "053673450002",
            "type": "uk_person_number",
            "label": "Uk Person Number"
          }
        ],
        "label": "Mr Thomas Bangalter",
        "pep": false,
        "psa_count": 0,
        "related_entities_count": 1,
        "relationship_count": {
          "registered_agent_of": 1,
          "shareholder_of": 1,
          "director_of": 1
        },
        "risk": {
          "basel_aml": {
            "value": 3.67,
            "metadata": {
              "country": [
                "GBR"
              ]
            },
            "level": "relevant"
          },
          "cpi_score": {
            "value": 71,
            "metadata": {
              "country": [
                "FRA"
              ]
            },
            "level": "relevant"
          }
        },
        "sanctioned": false,
        "source_count": {
          "4ea8bac1bed868e1510ffd21842e9551": {
            "count": 28,
            "label": "UK Persons with Significant Control"
          },
          "ecdfb3f2ecc8c3797e77d5795a8066ef": {
            "count": 17,
            "label": "UK Corporate Registry"
          }
        },
        "trade_count": {
          "sent": 0,
          "received": 0
        },
        "type": "person",
        "user_attribute_count": {},
        "user_record_count": 0,
        "user_related_entities_count": 0,
        "user_relationship_count": {},
        "date_of_birth": "1975-01",
        "logistics_entity": false,
        "reference_id": "ecdfb3f2ecc8c3797e77d5795a8066ef/03389614/1540252800000:9030330caf25555c42c0bc0d84ea4aa1"
      },
      "path": [
        {
          "field": "has_lawyer",
          "entity": {
            "addresses": [
              "Fross Zelnick Lehrman & Zissu, P.C., 866 United Nations Plaza, New York NY 10017",
              "FROSS ZELNICK LEHRMAN & ZISSU, P.C., 4 TIMES SQUARE, 17TH FLOOR, NEW YORK, NY 10036",
              "Fross Zelnick Lehrman & Zissu, P.C., 151 West 42nd Street, 17th Floor, New York, NY 10036"
            ],
            "attribute_count": {
              "country": 1,
              "address": 5,
              "name": 1
            },
            "closed": false,
            "countries": [
              "USA"
            ],
            "degree": 179,
            "entity_url": "/v1/entity/xthsA_jQuKn3GW8-9ILQqg",
            "id": "xthsA_jQuKn3GW8-9ILQqg",
            "identifiers": [],
            "label": "LAWRENCE E. APOLZON",
            "pep": false,
            "psa_count": 0,
            "related_entities_count": 179,
            "relationship_count": {
              "lawyer_of": 179
            },
            "risk": {},
            "sanctioned": false,
            "source_count": {
              "ac1fa195f9cd4ccf657bca3c6db0bb19": {
                "count": 199,
                "label": "USA Patents and Trademark Office Trademark Applications"
              }
            },
            "trade_count": {
              "sent": 0,
              "received": 0
            },
            "type": "person",
            "user_attribute_count": {},
            "user_record_count": 0,
            "user_related_entities_count": 0,
            "user_relationship_count": {},
            "logistics_entity": false,
            "reference_id": "ac1fa195f9cd4ccf657bca3c6db0bb19/76232419/1717632000000:6d0f0edbd065319df4be58c3bc7909f5"
          },
          "relationships": {
            "has_lawyer": {
              "values": [
                {
                  "record": "ac1fa195f9cd4ccf657bca3c6db0bb19/76082348/1717632000000",
                  "attributes": {},
                  "acquisition_date": "2024-06-06"
                }
              ]
            }
          }
        }
      ]
    }
  ]
}

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

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