Get Project Entities

Beta

GET

/v1/projects/:project_id/entities

GET

/v1/projects/:project_id/entities

1 from sayari import Sayari
2 
3 client = Sayari(
4     client_id="YOUR_CLIENT_ID",
5     client_secret="YOUR_CLIENT_SECRET",
6 )
7 client.project_entity.get_project_entities(
8     project_id="YVB88Y",
9 )

Try it

200Retrieved

1 {
2   "limit": 20,
3   "data": [
4     {
5       "project_entity_id": "52z4Wa",
6       "project_id": "YVB88Y",
7       "label": "VTB Bank",
8       "upload_ids": [],
9       "strength": "strong",
10       "created_at": "2025-04-22 22:54:00.913586+00",
11       "attributes": {
12         "name": {
13           "resolve": true,
14           "values": [
15             "VTB Bank"
16           ]
17         },
18         "country": {
19           "resolve": true,
20           "values": [
21             "RUS"
22           ]
23         },
24         "address": {
25           "resolve": true,
26           "values": [
27             "Moscow"
28           ]
29         },
30         "identifier": {
31           "resolve": true,
32           "values": [
33             "253400V1H6ART1UQ0N98"
34           ]
35         }
36       },
37       "matches": [
38         {
39           "match_id": "52z4Wa:dy-rh2g0QtzUN_jC_e9S_A",
40           "sayari_entity_id": "dy-rh2g0QtzUN_jC_e9S_A",
41           "type": "company",
42           "label": "ОТКРЫТОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"РОССИЙСКИЕ ЖЕЛЕЗНЫЕ ДОРОГИ\"",
43           "matched_attributes": {
44             "name": [
45               "<em>БАНК</em> <em>ВТБ</em> (ПАО)",
46               "<em>VTB</em> <em>BANK</em> (PJSC)",
47               "<em>БАНК</em> <em>ВТБ</em> (ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО)",
48               "<em>VTB</em> <em>BANK</em> (PUBLIC JOINT STOCK COMPANY)",
49               "<em>VTB</em> <em>Bank</em>"
50             ],
51             "address": [
52               "109147 <em>Moscow</em>, st. Vorontsovskaya, 43 building 1",
53               "119121 <em>Moscow</em>, st. Plyushchikha, 37.",
54               "Vorontsovskaya Str., 43 <em>Moscow</em> 109044 RUSSIAN FEDERATION",
55               "37 Plyushchikha ul., <em>Moscow</em>, 119121, Russia",
56               "Bashnya Zapad, Kompleks Federatsiya, 12, nab. Presnenskaya, <em>Moscow</em>, 123317, Russia"
57             ],
58             "country": [
59               "<em>RUS</em>"
60             ],
61             "identifier": [
62               "<em>253400V1H6ART1UQ0N98</em>",
63               "<em>253400V1H6ART1UQ0N98</em>"
64             ]
65           },
66           "countries": [
67             "USA",
68             "CYP",
69             "ITA",
70             "CHN",
71             "RUS",
72             "UKR",
73             "IND",
74             "IRL",
75             "KAZ",
76             "DEU"
77           ],
78           "risks": [
79             "regulatory_action",
80             "sanctioned",
81             "meu_list_contractors",
82             "reputational_risk_other",
83             "pep_adjacent",
84             "state_owned",
85             "export_controls",
86             "formerly_sanctioned",
87             "basel_aml",
88             "cpi_score"
89           ],
90           "business_purpose": [
91             {
92               "code": "6419",
93               "standard": "ISIC4"
94             },
95             {
96               "code": "64.19",
97               "standard": "unknown"
98             },
99             {
100               "code": "64.9",
101               "standard": "unknown"
102             },
103             {
104               "code": "62.09",
105               "standard": "unknown"
106             },
107             {
108               "code": "64.19",
109               "standard": "NACE2"
110             },
111             {
112               "code": "64.19",
113               "standard": "unknown"
114             },
115             {
116               "code": "649",
117               "standard": "ISIC4"
118             },
119             {
120               "code": "66.12",
121               "standard": "unknown"
122             },
123             {
124               "code": "6419",
125               "standard": "ISIC4"
126             },
127             {
128               "code": "6209",
129               "standard": "ISIC4"
130             },
131             {
132               "code": "6612",
133               "standard": "ISIC4"
134             }
135           ],
136           "upstream": {
137             "risks": [],
138             "countries": [],
139             "trade_counts": {
140               "receiver_of": 2,
141               "shipper_of": 56
142             },
143             "has_upstream": false,
144             "products": []
145           },
146           "sources": [
147             {
148               "id": "eb361ba33d05a9d15b2d28aea739362a",
149               "label": "USA SEC Central Index Key Database"
150             },
151             {
152               "id": "a8c6ee1cd4dfc952105ee8c0e4836f08",
153               "label": "Acuris Risk Intelligence KYC6 (3rd Party Data)"
154             },
155             {
156               "id": "3322a755c28851ec06eda3280cc2a2b2",
157               "label": "Russia ClearSpending (3rd Party Data)"
158             },
159             {
160               "id": "93de05b55a68cc964f34bbfc7ec7bc86",
161               "label": "Consolidated Canadian Autonomous Sanctions List"
162             },
163             {
164               "id": "fdfedf11a5122e2aef9dc3f176c7427d",
165               "label": "Sayari Intel (Sayari Curated Risk Data) - Archived"
166             },
167             {
168               "id": "e517c714b560f159a89a9501ed7dd84e",
169               "label": "Infocredit Cyprus Company Shareholders Database (3rd Party Data)"
170             },
171             {
172               "id": "bef2f30139ea37c723ecb0f953b5f024",
173               "label": "Australia Consolidated Sanctions List"
174             },
175             {
176               "id": "9048153c770d941afe9500c6ad810a80",
177               "label": "Kazakhstan DFO Registry"
178             },
179             {
180               "id": "635021e4e01979cdf95fa7ee76501696",
181               "label": "Russia E-Disclosures"
182             },
183             {
184               "id": "e85d865943ee6d8369307569d2ad9de0",
185               "label": "Acuris Risk Intelligence Adverse Media Data"
186             },
187             {
188               "id": "4ff85397f508e4ff8e71c5ca5ea895dd",
189               "label": "Japan Ministry of Finance Economic Sanctions List"
190             },
191             {
192               "id": "ce873f184abee5b13c9e89791bd78229",
193               "label": "Ukraine Significant Shareholders of Securities Issuers"
194             },
195             {
196               "id": "8511f57f6098dcc36e3a814c3ea5bdd7",
197               "label": "Uzbekistan Imports & Exports (January 2022 - Present)"
198             },
199             {
200               "id": "e6e4acebdea4e9e71af8d3586d34fcdd",
201               "label": "Ukraine Sanctions List"
202             },
203             {
204               "id": "db3416894cd5f0c4d2d6ecc79bdaf366",
205               "label": "EDI Publicly-Listed Global Security Issuers (3rd Party Data)"
206             },
207             {
208               "id": "b812677c0a32a1746b3ac741c7b97ae0",
209               "label": "Legal Entity Identifier (LEI) Registry (3rd Party Data)"
210             },
211             {
212               "id": "a9a18eeb901e4376c912e95dc05ceb78",
213               "label": "Russia Federal Tax Registry"
214             },
215             {
216               "id": "d357238101a2bb02d97d5d77a56d9455",
217               "label": "New Zealand Russia Sanctions"
218             },
219             {
220               "id": "f4ce10ac8bdc0bd9bcb31cb868b4b539",
221               "label": "EU Financial Sanctions List"
222             },
223             {
224               "id": "c10d482320f207d92aa814519c3bd686",
225               "label": "UK Consolidated Sanctions List"
226             },
227             {
228               "id": "d1bce737c158efddbef5048d63aaf124",
229               "label": "Ukraine Ministry of Justice Registry of Companies"
230             },
231             {
232               "id": "92edb8fe6615498f6e3e7b0e220f74e6",
233               "label": "USA Treasury OFAC Specially Designated Nationals (SDN) List"
234             },
235             {
236               "id": "66dfefb726ae00fde8f09f34c5578d35",
237               "label": "Russia Imports & Exports (January 2023 - Present)"
238             },
239             {
240               "id": "ad6dc774c74b92159422deabc5aee661",
241               "label": "France National Asset Freeze Register"
242             },
243             {
244               "id": "b97ad5c858093e5227b2359a0078696f",
245               "label": "USA SAM.gov Entity Exclusions Database"
246             },
247             {
248               "id": "ddbf93a5c5d568ccdb0c2455f7ecbfc8",
249               "label": "USA CorpWatch SEC 10-K Exhibit 21 Database (3rd Party Data)"
250             },
251             {
252               "id": "52a7bc4a30e787544ad2d95e7f54adca",
253               "label": "USA OFAC Non-SDN Consolidated Sanctions List"
254             },
255             {
256               "id": "f43658cf2a19452fb45b830edeeeea44",
257               "label": "Russia Central Bank Financial Institution UBO Disclosures"
258             },
259             {
260               "id": "828f81c7c31410de845d9e6ed1a0f3e6",
261               "label": "Russia Central Bank Financial Institutions"
262             },
263             {
264               "id": "56bce0e008204712e302271ddd7b4fb1",
265               "label": "Russia Federal Tax Registry (2018)"
266             },
267             {
268               "id": "e0b32f41da3b4e6c75f1f7bf6fe1c9c5",
269               "label": "S&P Global Market Intelligence Database (3rd Party Data)"
270             },
271             {
272               "id": "10a889609ddae6cc31773feebe48166b",
273               "label": "Switzerland SECO Sanctions List"
274             },
275             {
276               "id": "ded706ef28cdc649b6fc5142bc542890",
277               "label": "EU Sanctions Map"
278             },
279             {
280               "id": "417400a1ac439843fda5bb2f05fb4161",
281               "label": "USA Consolidated Screening List"
282             },
283             {
284               "id": "765d0dc816bb7db35031c43a37290350",
285               "label": "Ireland Companies Registration Office Database"
286             }
287           ],
288           "addresses": [
289             {
290               "value": "190000, г Санкт-Петербург, ул Большая Морская, дом 29"
291             },
292             {
293               "value": "109147 г. Москва, ул. Воронцовская, д.43 стр.1"
294             },
295             {
296               "value": "119121 г. Москва, ул. Плющиха, д. 37."
297             },
298             {
299               "value": "43, Vorontsovskaya str., Moscow, 109044, Russia"
300             },
301             {
302               "value": "11, lit A, Degtyarnyy pereulok, St. Petersburg, 191144, Russia"
303             },
304             {
305               "value": "29, Bolshaya Morskaya str., St. Petersburg, 190000, Russia"
306             }
307           ],
308           "hs_codes": [
309             "847150",
310             "8471500000",
311             "852351",
312             "8523519101",
313             "860610",
314             "8606100000",
315             "271019",
316             "2710196601",
317             "490700",
318             "4907003000",
319             "711890",
320             "7118900000",
321             "490700",
322             "4907003000",
323             "711890",
324             "7118900000"
325           ],
326           "created_at": "2025-04-22 22:54:00.913586+00",
327           "updated_at": "2025-04-22 22:54:00.913586+00"
328         }
329       ],
330       "tags": [],
331       "case": "not_assigned"
332     }
333   ],
334   "size": {
335     "count": 1,
336     "qualifier": "eq"
337   }
338 }

Retrieves a list of entities for a specific project with pagination support.

Path parameters

project_idstringRequired

Query parameters

entity_idlist of stringsOptional

Filter by entity IDs

uploadslist of stringsOptional

Filter by upload IDs

case_statuslist of enumsOptional

Filter by case status

Allowed values:

tagslist of stringsOptional

Filter by tag IDs

match_resultlist of enumsOptional

Filter by match result

Allowed values:

match_strength_v1list of enumsOptional

Filter by match strength

Allowed values:

entity_typeslist of stringsOptional

Filter by entity types

geo_facetsbooleanOptionalDefaults to false

Include geo facets

exact_matchbooleanOptional

Use exact matching

hs_codeslist of stringsOptional

Filter by HS codes

received_hs_codeslist of stringsOptional

Filter by received HS codes

shipped_hs_codeslist of stringsOptional

Filter by shipped HS codes

upstream_productlist of stringsOptional

Filter by upstream product

limitintegerOptional

Maximum number of results to return

tokenstringOptional

Pagination token

sortlist of stringsOptional

Sort fields

aggregationslist of stringsOptional

Fields to aggregate

num_aggregation_bucketsintegerOptional

Number of aggregation buckets

risklist of enumsOptional

List of risk factors to filter by

risk_categorylist of enumsOptional

List of risk categories to filter by. An entity matches if it has any risk factor belonging to one of the specified categories

Response

This endpoint returns an object.

limitinteger

datalist of objects

sizeobject

next_tokenstringOptional

prev_tokenstringOptional

Get Project Entities

Path parameters

Headers

Query parameters

Response

Errors