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
  • 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 ReferenceEntity

GA
GET
/v1/entity/:id
GET
/v1/entity/:id
1curl -G https://api.sayari.com/v1/entity/mGq1lpuqKssNWTjIokuPeA \
2 -H "Authorization: Bearer <token>" \
3 -d attributes.name.limit=1 \
4 -d attributes.address.limit=1 \
5 -d attributes.country.limit=1 \
6 -d attributes.additional_information.limit=1 \
7 -d attributes.business_purpose.limit=1 \
8 -d attributes.company_type.limit=1 \
9 -d attributes.identifier.limit=1 \
10 -d attributes.status.limit=1 \
11 -d relationships.limit=1 \
12 -d possibly_same_as.limit=1 \
13 -d referenced_by.limit=1
Try it
200Retrieved
1{
2 "addresses": [
3 "202 HAMMERSMITH ROAD , LONDON , , UNITED KINGDOM , W6 7DN , GB",
4 "Unit 33, Ransomes Dock Business Centre, 35-37 Parkgate Road, London SW11 4NP",
5 "SAUNDERS BUILDING, 202 HAMMERSMITH ROAD, HAMMERSMITH, LONDON"
6 ],
7 "attribute_count": {
8 "company_type": 2,
9 "name": 2,
10 "business_purpose": 4,
11 "identifier": 3,
12 "additional_information": 106,
13 "country": 8,
14 "status": 5,
15 "address": 7
16 },
17 "closed": false,
18 "countries": [
19 "GBR",
20 "USA"
21 ],
22 "degree": 67,
23 "entity_url": "/v1/entity/mGq1lpuqKssNWTjIokuPeA",
24 "id": "mGq1lpuqKssNWTjIokuPeA",
25 "identifiers": [
26 {
27 "value": "06517802",
28 "type": "uk_company_number",
29 "label": "Uk Company Number"
30 },
31 {
32 "value": "6517802",
33 "type": "unknown",
34 "label": "Unknown"
35 },
36 {
37 "value": "04781466",
38 "type": "ca_corporate_id_num",
39 "label": "Ca Corporate Id Num"
40 }
41 ],
42 "label": "VICTORIA BECKHAM LIMITED",
43 "pep": false,
44 "psa_count": 3,
45 "related_entities_count": 67,
46 "relationship_count": {
47 "linked_to": 3,
48 "has_officer": 2,
49 "shareholder_of": 1,
50 "has_shareholder": 2,
51 "has_registered_agent": 5,
52 "shipper_of": 41,
53 "has_director": 11,
54 "owner_of": 3,
55 "has_founder": 1,
56 "ships_to": 1
57 },
58 "risk": {
59 "basel_aml": {
60 "value": 4.63,
61 "metadata": {
62 "country": [
63 "USA"
64 ]
65 },
66 "level": "relevant"
67 },
68 "cpi_score": {
69 "value": 67,
70 "metadata": {
71 "country": [
72 "USA"
73 ]
74 },
75 "level": "relevant"
76 }
77 },
78 "sanctioned": false,
79 "source_count": {
80 "2b618f1996252fe537a6d998ae14c9b2": {
81 "count": 1,
82 "label": "UK Corporate Registry Confirmation Statements"
83 },
84 "2b788dbdf9194ed5a5c309386a6516b1": {
85 "count": 28,
86 "label": "UK HM Revenue & Customs Traders Database"
87 },
88 "a447a7b622c4ead6e1caf94983dc2337": {
89 "count": 6,
90 "label": "USA California Secretary of State"
91 },
92 "ecdfb3f2ecc8c3797e77d5795a8066ef": {
93 "count": 35,
94 "label": "UK Corporate Registry"
95 },
96 "e5de7b52cc88ef4cd1a10e201bdf46ee": {
97 "count": 41,
98 "label": "Vietnam Imports & Exports (January 2023 - Present)"
99 },
100 "2a4fe9a14e332c8f9ded1f8a457c2b89": {
101 "count": 36,
102 "label": "UK Land Commercial and Corporate Ownership Data (CCOD)"
103 },
104 "4ea8bac1bed868e1510ffd21842e9551": {
105 "count": 69,
106 "label": "UK Persons with Significant Control"
107 }
108 },
109 "trade_count": {
110 "sent": 41,
111 "received": 0
112 },
113 "type": "company",
114 "user_attribute_count": {},
115 "user_record_count": 0,
116 "user_related_entities_count": 0,
117 "user_relationship_count": {},
118 "attributes": {
119 "additional_information": {
120 "data": [
121 {
122 "properties": {
123 "type": "Traded Goods"
124 },
125 "record": [
126 "2b788dbdf9194ed5a5c309386a6516b1/22950249e3df0c33ce05bd54850ba9f3/1672444800000"
127 ],
128 "record_count": 9,
129 "editable": false
130 }
131 ],
132 "limit": 1,
133 "size": {
134 "count": 106,
135 "qualifier": "eq"
136 },
137 "next": "_SjfEipa7hytJ93C1IT_sg"
138 },
139 "address": {
140 "data": [
141 {
142 "properties": {
143 "country": "United Kingdom",
144 "house_number": "202",
145 "normalized": "202 HAMMERSMITH KINGDOM RD UNITED",
146 "precision_code": "G3",
147 "road": "Hammersmith Road",
148 "value": "202 HAMMERSMITH ROAD UNITED KINGDOM",
149 "x": -0.22579,
150 "y": 51.49291
151 },
152 "record": [
153 "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1678752000000"
154 ],
155 "record_count": 5,
156 "editable": false
157 }
158 ],
159 "limit": 1,
160 "size": {
161 "count": 7,
162 "qualifier": "eq"
163 },
164 "next": "5TPSsmsFxea24_QTyk8o1Q"
165 },
166 "business_purpose": {
167 "data": [
168 {
169 "properties": {
170 "code": "9329",
171 "standard": "ISIC4",
172 "value": "Other amusement and recreation activities n.e.c."
173 },
174 "record": [
175 "9aef3a56aa0ea25404b498dbd8bb447f/06517802/1579014552807"
176 ],
177 "record_count": 18,
178 "editable": false
179 }
180 ],
181 "limit": 1,
182 "size": {
183 "count": 4,
184 "qualifier": "eq"
185 },
186 "next": "5fZrn5ZbUyo6d_huc6NlAA"
187 },
188 "company_type": {
189 "data": [
190 {
191 "properties": {
192 "value": "Stock Corporation - Out of State - Stock"
193 },
194 "record": [
195 "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1649116800000"
196 ],
197 "record_count": 6,
198 "editable": false
199 }
200 ],
201 "limit": 1,
202 "size": {
203 "count": 2,
204 "qualifier": "eq"
205 },
206 "next": "iuJ_MCygy24sDCcVkbCATA"
207 },
208 "country": {
209 "data": [
210 {
211 "properties": {
212 "value": "GBR",
213 "context": "address"
214 },
215 "record": [
216 "9aef3a56aa0ea25404b498dbd8bb447f/06517802/1579014552807"
217 ],
218 "record_count": 23,
219 "editable": false
220 }
221 ],
222 "limit": 1,
223 "size": {
224 "count": 8,
225 "qualifier": "eq"
226 },
227 "next": "_ZTsEnhxCbjokYYWu1kMoQ"
228 },
229 "identifier": {
230 "data": [
231 {
232 "properties": {
233 "type": "ca_corporate_id_num",
234 "value": "04781466"
235 },
236 "record": [
237 "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1649116800000"
238 ],
239 "record_count": 6,
240 "editable": false
241 }
242 ],
243 "limit": 1,
244 "size": {
245 "count": 3,
246 "qualifier": "eq"
247 },
248 "next": "07v3Rsu6x-gDuukFa0jEsw"
249 },
250 "name": {
251 "data": [
252 {
253 "properties": {
254 "value": "BECKHAM VENTURES LIMITED",
255 "context": "alias",
256 "to_date": "2014-09-03"
257 },
258 "record": [
259 "2a4fe9a14e332c8f9ded1f8a457c2b89/NGL944625/1560779151522"
260 ],
261 "record_count": 30,
262 "editable": false
263 }
264 ],
265 "limit": 1,
266 "size": {
267 "count": 2,
268 "qualifier": "eq"
269 },
270 "next": "5lxpjuZmt31xiCnbDILp0A"
271 },
272 "status": {
273 "data": [
274 {
275 "properties": {
276 "text": "Good"
277 },
278 "record": [
279 "9139b58de1bdb0157a1a1e54e56df6d3/4781466/1649116800000"
280 ],
281 "record_count": 6,
282 "editable": false
283 }
284 ],
285 "limit": 1,
286 "size": {
287 "count": 5,
288 "qualifier": "eq"
289 },
290 "next": "EdC1n7V2lU0oKTokzO_YLw"
291 }
292 },
293 "company_type": "Stock Corporation - Out of State - Stock",
294 "latest_status": {
295 "status": "active",
296 "date": "2023-08-29"
297 },
298 "logistics_entity": false,
299 "possibly_same_as": {
300 "data": [
301 {
302 "entity": {
303 "addresses": [
304 "99 WASHINGTON AVE., SUITE 805A, ALBANY, NY, 12201",
305 "511 WEST 25TH STREET, SUITE # 701/7TH FLOOR, NEW YORK, NEW YORK, 10001",
306 "80 STATE STREET, ALBANY, NEW YORK, 12207-2543"
307 ],
308 "attribute_count": {
309 "company_type": 1,
310 "name": 1,
311 "identifier": 1,
312 "country": 3,
313 "status": 1,
314 "address": 3
315 },
316 "closed": false,
317 "countries": [
318 "USA"
319 ],
320 "degree": 3,
321 "entity_url": "/v1/entity/NGUTEUTI4YZ6R5d56vgNIw",
322 "id": "NGUTEUTI4YZ6R5d56vgNIw",
323 "identifiers": [
324 {
325 "value": "4346762",
326 "type": "usa_ny_dos_id",
327 "label": "Usa Ny Dos Id"
328 }
329 ],
330 "label": "BECKHAM VENTURES INC.",
331 "pep": false,
332 "psa_count": 3,
333 "related_entities_count": 3,
334 "relationship_count": {
335 "has_officer": 1,
336 "has_registered_agent": 2,
337 "linked_to": 2
338 },
339 "risk": {
340 "basel_aml": {
341 "value": 4.63,
342 "metadata": {
343 "country": [
344 "USA"
345 ]
346 },
347 "level": "relevant"
348 },
349 "cpi_score": {
350 "value": 67,
351 "metadata": {
352 "country": [
353 "USA"
354 ]
355 },
356 "level": "relevant"
357 }
358 },
359 "sanctioned": false,
360 "source_count": {
361 "b4d06d4b77f51fab3c77c9653aabdda4": {
362 "count": 8,
363 "label": "USA New York Corporate Registry (Active Entities)"
364 }
365 },
366 "trade_count": {
367 "sent": 0,
368 "received": 0
369 },
370 "type": "company",
371 "user_attribute_count": {},
372 "user_record_count": 0,
373 "user_related_entities_count": 0,
374 "user_relationship_count": {},
375 "company_type": "FOREIGN BUSINESS CORPORATION",
376 "latest_status": {
377 "status": "active",
378 "date": "2013-01-16"
379 },
380 "logistics_entity": false,
381 "psa_id": "695785012897",
382 "reference_id": "b4d06d4b77f51fab3c77c9653aabdda4/a80e7f4c-c219-437b-9941-32d89ea5885a/1560542045043:15d813b260619393762864f22d3c5b2d",
383 "registration_date": " 2013-01-16"
384 },
385 "matches": {},
386 "editable": false
387 }
388 ],
389 "limit": 1,
390 "size": {
391 "count": 3,
392 "qualifier": "eq"
393 },
394 "next": "eyJ0eXBlIjoic2F5YXJpIiwib2Zmc2V0IjoxfQ"
395 },
396 "psa_id": "695785012897",
397 "reference_id": "ecdfb3f2ecc8c3797e77d5795a8066ef/06517802/1540252800000:4a34442eccf1622995130b194a5d50e7",
398 "referenced_by": {
399 "data": [
400 {
401 "record": {
402 "id": "e5de7b52cc88ef4cd1a10e201bdf46ee/{D634B9B1-39E2-4273-8F35AE81130E18D7}/1704240000000",
403 "label": "Trade Record from Vietnam Imports & Exports (January 2023 - Present)",
404 "source": "e5de7b52cc88ef4cd1a10e201bdf46ee",
405 "acquisition_date": "2024-01-03",
406 "references_count": 3,
407 "record_url": "/record/e5de7b52cc88ef4cd1a10e201bdf46ee%2F%7BD634B9B1-39E2-4273-8F35AE81130E18D7%7D%2F1704240000000",
408 "publication_date": "2024-01-03"
409 },
410 "type": "mentions"
411 }
412 ],
413 "limit": 1,
414 "size": {
415 "count": 216,
416 "qualifier": "eq"
417 },
418 "next": "Vk5NfGdsb2JhbF90cmFkZV90YV92bm18ZnwyMDI0LTAxLTAzfHtENjM0QjlCMS0zOUUyLTQyNzMtOEYzNUFFODExMzBFMThEN318MTcwNDI0MDAwMDAwMA"
419 },
420 "registration_date": "Incorporated 2008-02-28",
421 "relationships": {
422 "data": [
423 {
424 "target": {
425 "addresses": [
426 "35-37 Parkgate Road, London, SW11 4NP",
427 "Hammersmith Road, London",
428 "202 HAMMERSMITH ROAD, LONDON, W6 7DN"
429 ],
430 "attribute_count": {
431 "company_type": 1,
432 "name": 2,
433 "business_purpose": 3,
434 "identifier": 1,
435 "additional_information": 1,
436 "country": 3,
437 "status": 2,
438 "address": 3
439 },
440 "closed": false,
441 "countries": [
442 "GBR"
443 ],
444 "degree": 17,
445 "entity_url": "/v1/entity/zenMMQtpFHx9Cam_2nDndg",
446 "id": "zenMMQtpFHx9Cam_2nDndg",
447 "identifiers": [
448 {
449 "value": "11043864",
450 "type": "uk_company_number",
451 "label": "Uk Company Number"
452 }
453 ],
454 "label": "Victoria Beckham Holdings Limited",
455 "pep": false,
456 "psa_count": 0,
457 "related_entities_count": 17,
458 "relationship_count": {
459 "shareholder_of": 2,
460 "has_shareholder": 5,
461 "has_registered_agent": 1,
462 "has_director": 9,
463 "linked_to": 7
464 },
465 "risk": {
466 "basel_aml": {
467 "value": 3.99,
468 "metadata": {
469 "country": [
470 "GBR"
471 ]
472 },
473 "level": "relevant"
474 },
475 "cpi_score": {
476 "value": 78,
477 "metadata": {
478 "country": [
479 "GBR"
480 ]
481 },
482 "level": "relevant"
483 }
484 },
485 "sanctioned": false,
486 "source_count": {
487 "ecdfb3f2ecc8c3797e77d5795a8066ef": {
488 "count": 34,
489 "label": "UK Corporate Registry"
490 },
491 "2b618f1996252fe537a6d998ae14c9b2": {
492 "count": 1,
493 "label": "UK Corporate Registry Confirmation Statements"
494 },
495 "4ea8bac1bed868e1510ffd21842e9551": {
496 "count": 147,
497 "label": "UK Persons with Significant Control"
498 }
499 },
500 "trade_count": {
501 "sent": 0,
502 "received": 0
503 },
504 "type": "company",
505 "user_attribute_count": {},
506 "user_record_count": 0,
507 "user_related_entities_count": 0,
508 "user_relationship_count": {},
509 "company_type": "Private Limited Company",
510 "latest_status": {
511 "status": "active"
512 },
513 "logistics_entity": false,
514 "reference_id": "ecdfb3f2ecc8c3797e77d5795a8066ef/11043864/1540252800000:40ec7b0310d308ebf9006148b53a2802",
515 "registration_date": "Incorporated 2017-11-02"
516 },
517 "types": {
518 "has_shareholder": [
519 {
520 "record": "4ea8bac1bed868e1510ffd21842e9551/56910fae410d43596d5a94fd9405023a/1711843200000",
521 "attributes": {},
522 "acquisition_date": "2024-03-31",
523 "editable": false
524 },
525 {
526 "record": "4ea8bac1bed868e1510ffd21842e9551/06517802/1560176240192",
527 "attributes": {
528 "position": [
529 {
530 "value": "Has right to appoint and remove directors"
531 },
532 {
533 "value": "Owns 75-100% of shares"
534 },
535 {
536 "value": "Owns 75-100% of voting rights"
537 }
538 ],
539 "shares": [
540 {
541 "percentage": 75
542 }
543 ]
544 },
545 "acquisition_date": "2019-06-10",
546 "editable": false
547 }
548 ],
549 "linked_to": [
550 {
551 "record": "4ea8bac1bed868e1510ffd21842e9551/56910fae410d43596d5a94fd9405023a/1711843200000",
552 "attributes": {},
553 "acquisition_date": "2024-03-31",
554 "editable": false
555 },
556 {
557 "record": "4ea8bac1bed868e1510ffd21842e9551/06517802/1560176240192",
558 "attributes": {
559 "position": [
560 {
561 "value": "Has right to appoint and remove directors"
562 },
563 {
564 "value": "Owns 75-100% of shares"
565 },
566 {
567 "value": "Owns 75-100% of voting rights"
568 }
569 ]
570 },
571 "acquisition_date": "2019-06-10",
572 "editable": false
573 }
574 ]
575 },
576 "dates": [
577 "2017-11-16"
578 ],
579 "first_observed": "2017-11-16",
580 "last_observed": "2017-11-16"
581 }
582 ],
583 "limit": 1,
584 "size": {
585 "count": 67,
586 "qualifier": "eq"
587 },
588 "next": "fzenMMQtpFHx9Cam_2nDndg"
589 }
590}
Was this page helpful?
Previous

Entity Summary

Next
Built with
<Note>To retrieve a L1 Due Dilligence PDF Report. Include 'Accept: application/pdf' in request headers.</Note> Retrieve an entity profile from the database based on the entity ID. This endpoint returns the full profile, entity_summary returns the same payload minus relationships.
Get Entity

To retrieve a L1 Due Dilligence PDF Report. Include ‘Accept: application/pdf’ in request headers.
Retrieve an entity profile from the database based on the entity ID. This endpoint returns the full profile, entity_summary returns the same payload minus relationships.

Authentication

AuthorizationBearer
OAuth authentication of the form `<token>`.

Path parameters

idstringRequired
Unique identifier of the entity

Query parameters

attributes.additional_information.nextstringOptional
The pagination token for the next page of attribute `additional_information`.
attributes.additional_information.prevstringOptional
The pagination token for the previous page of attribute `additional_information`.
attributes.additional_information.limitintegerOptional
Limit total values returned for attribute `additional_information`. Defaults to 100.
attributes.address.nextstringOptional
The pagination token for the next page of attribute `address`.
attributes.address.prevstringOptional
The pagination token for the previous page of attribute `address`.
attributes.address.limitintegerOptional
Limit total values returned for attribute `address`. Defaults to 100.
attributes.business_purpose.nextstringOptional
The pagination token for the next page of attribute `business_purpose`.
attributes.business_purpose.prevstringOptional
The pagination token for the previous page of attribute `business_purpose`.
attributes.business_purpose.limitintegerOptional
Limit total values returned for attribute `business_purpose`. Defaults to 100.
attributes.company_type.nextstringOptional
The pagination token for the next page of attribute `company_type`.
attributes.company_type.prevstringOptional
The pagination token for the previous page of attribute `company_type`.
attributes.company_type.limitintegerOptional
Limit total values returned for attribute `company_type`. Defaults to 100.
attributes.country.nextstringOptional
The pagination token for the next page of attribute `country`.
attributes.country.prevstringOptional
The pagination token for the previous page of attribute `country`.
attributes.country.limitintegerOptional
Limit total values returned for attribute `country`. Defaults to 100.
attributes.identifier.nextstringOptional
The pagination token for the next page of attribute `identifier`.
attributes.identifier.prevstringOptional
The pagination token for the previous page of attribute `identifier`.
attributes.identifier.limitintegerOptional
Limit total values returned for attribute `identifier`. Defaults to 100.
attributes.name.nextstringOptional
The pagination token for the next page of attribute `name`.
attributes.name.prevstringOptional
The pagination token for the previous page of attribute `name`.
attributes.name.limitintegerOptional
Limit total values returned for attribute `name`. Defaults to 100.
attributes.status.nextstringOptional
The pagination token for the next page of attribute `status`.
attributes.status.prevstringOptional
The pagination token for the previous page of attribute `status`.
attributes.status.limitintegerOptional
Limit total values returned for attribute `status`. Defaults to 100.
relationships.nextstringOptional
The pagination token for the next page of relationship results
relationships.prevstringOptional
The pagination token for the previous page of relationship results
relationships.limitintegerOptional
Limit total relationship values. Defaults to 50.
relationships.typeenumOptional
Filter relationships to [relationship type](/sayari-library/ontology/relationships), e.g. director_of or has_shareholder
relationships.sortstringOptional
Sorts relationships by As Of date or Shareholder percentage, e.g. date or -shares
relationships.startDatedateOptional
Filters relationships to after a date
relationships.endDatedateOptional
Filters relationships to before a date
relationships.minSharesintegerOptional
Filters relationships to greater than or equal to a Shareholder percentage
relationships.countryenumOptional
Filters relationships to a list of [countries](/sayari-library/ontology/enumerated-types#country)
relationships.arrivalCountryenumOptional
Filters shipment relationships to a list of arrival [countries](/sayari-library/ontology/enumerated-types#country)
relationships.arrivalStatestringOptional
Filters shipment relationships to an arrival state
relationships.arrivalCitystringOptional
Filters shipment relationships to an arrival city
relationships.departureCountryenumOptional
Filters shipment relationships to a list of departure [countries](/sayari-library/ontology/enumerated-types#country)
relationships.departureStatestringOptional
Filters shipment relationships to a departure state
relationships.departureCitystringOptional
Filters shipment relationships to a departure city
relationships.partnerNamestringOptional
Filters shipment relationships to a trade partner name
relationships.partnerRiskenumOptional
Filters shipment relationships to a trade partner [risk tag](/sayari-library/ontology/enumerated-types#tag)
relationships.hsCodestringOptional
Filters shipment relationships to an HS code
possibly_same_as.nextstringOptional
The pagination token for the next page of possibly same entities.
possibly_same_as.prevstringOptional
The pagination token for the previous page of possibly same entities.
possibly_same_as.limitintegerOptional
Limit total possibly same as entities. Defaults to 100.
referenced_by.nextstringOptional
The pagination token for the next page of the entity's referencing records
referenced_by.prevstringOptional
The pagination token for the previous page of the entity's referencing records
referenced_by.limitintegerOptional
Limit totals values returned for entity's referencing records. Defaults to 100.

Response

This endpoint returns an object.
addresseslist of strings

List of physical addresses associated with the entity. See more here

attribute_countmap from enums to integers

Count of attributes for a given attribute type

closedboolean
True if the entity existed in the past but not at the present time, otherwise false. Always false for data curation.
countrieslist of enums
Entity [country](/sayari-library/ontology/enumerated-types#country)
degreeinteger
Number of outgoing relationships
entity_urlstring
Convenience URL to the entity in the API.
idstring
Unique identifier of the entity
identifierslist of objects
labelstring
Display name of the entity
pepboolean
True if the entity has the ["Politically Exposed Person (PEP)" risk factor](/sayari-library/ontology/risk-factors#politically-exposed-person-pep-), otherwise false.
psa_countinteger
Number of entities that are Possibly the Same As (PSA) the entity.
related_entities_countinteger
relationship_countmap from enums to integers
Count of related entities for a given [relationship type](/sayari-library/ontology/relationships).
riskmap from enums to objects
[Risk factors](/sayari-library/ontology/risk-factors) associated with the entity.
sanctionedboolean
True if the entity has the ["Sanctioned" risk factor](/sayari-library/ontology/risk-factors#sanctioned), otherwise false.
source_countmap from strings to objects
Number of records associated with the entity, grouped by source.
trade_countmap from strings to integers
typeenum
The [entity type](/sayari-library/ontology/entities).
user_attribute_countmap from enums to integers
Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)
user_record_countinteger
user_related_entities_countinteger
user_relationship_countmap from enums to integers
Count of related entities for a given [relationship type](/sayari-library/ontology/relationships).
attribute_countsmap from enums to integers or null
Count of attributes for a given [attribute type](/sayari-library/ontology/attributes)
attributesobject or null
Detailed information about the entity's [attributes](/sayari-library/ontology/attributes).
company_typestring or null
A type of legal entity in a given jurisdiction (e.g. 'LLC,' 'Sociedad Anonima,' 'Private Company Limited by Shares')
date_of_birthstring or null
Birth date of a person. See more [here](/sayari-library/ontology/attributes#date-of-birth)
hs_codestring or null
Harmonized Tariff Schedule Code associated with the entity/shipment
latest_statusobject or null
The most recent status of an entity and when that status was observed.
logistics_entityboolean or null
possibly_same_asobject or null
List of entities that are Possibly the Same As (PSA) the entity.
psa_idstring or null
reference_idstring or null
referenced_byobject or null
List of records that reference the entity.
registration_datestring or null
Type (registered/incorporated/active) and date of the earliest significant activity associated with the entity. Will appear as 'Registered YYYY-MM-DD'
relationshipsobject or null
Detailed information about the entity's [relationships](/sayari-library/ontology/relationships).
shipment_arrivalstring or null
Arrival date of a shipment.
shipment_departurestring or null
Departure date of a shipment.
translated_labelstring or null
Label in English if available. Translation performed by Sayari.
user_attribute_countsmap from enums to integers or null
Count of user-created attributes for a given [attribute type](/sayari-library/ontology/attributes)

Errors

The pagination token for the next page of relationship results
The pagination token for the previous page of relationship results
Limit total relationship values. Defaults to 50.
Filters relationships to after a date
Filters relationships to before a date
Filters relationships to greater than or equal to a Shareholder percentage
Filters shipment relationships to an arrival state
Filters shipment relationships to an arrival city
Filters shipment relationships to a departure state
Filters shipment relationships to a departure city
Filters shipment relationships to a trade partner name
Filters shipment relationships to an HS code
The pagination token for the next page of possibly same entities.
The pagination token for the previous page of possibly same entities.
Limit total possibly same as entities. Defaults to 100.
The pagination token for the next page of the entity's referencing records
The pagination token for the previous page of the entity's referencing records
Limit totals values returned for entity's referencing records. Defaults to 100.

Entity country

True if the entity has the “Politically Exposed Person (PEP)” risk factor, otherwise false.

Number of entities that are Possibly the Same As (PSA) the entity.

Count of related entities for a given relationship type.

Count of related entities for a given relationship type.

Count of attributes for a given attribute type

Risk factors associated with the entity.

Birth date of a person. See more here

Harmonized Tariff Schedule Code associated with the entity/shipment

List of entities that are Possibly the Same As (PSA) the entity.

Type (registered/incorporated/active) and date of the earliest significant activity associated with the entity. Will appear as ‘Registered YYYY-MM-DD’

Detailed information about the entity’s relationships.

True if the entity has the “Sanctioned” risk factor, otherwise false.

The entity type.

Count of user-created attributes for a given attribute type

Count of user-created attributes for a given attribute type

Detailed information about the entity’s attributes.

A type of legal entity in a given jurisdiction (e.g. ‘LLC,’ ‘Sociedad Anonima,’ ‘Private Company Limited by Shares’)

OAuth authentication of the form <token>.

The pagination token for the next page of attribute additional_information.

The pagination token for the next page of attribute address.

Limit total values returned for attribute additional_information. Defaults to 100.

The pagination token for the previous page of attribute additional_information.

The pagination token for the previous page of attribute address.

The pagination token for the next page of attribute business_purpose.

Limit total values returned for attribute business_purpose. Defaults to 100.

Limit total values returned for attribute address. Defaults to 100.

The pagination token for the previous page of attribute business_purpose.

The pagination token for the next page of attribute company_type.

Limit total values returned for attribute company_type. Defaults to 100.

The pagination token for the previous page of attribute company_type.

The pagination token for the next page of attribute country.

Limit total values returned for attribute country. Defaults to 100.

The pagination token for the next page of attribute identifier.

The pagination token for the previous page of attribute country.

The pagination token for the previous page of attribute identifier.

The pagination token for the next page of attribute name.

Limit total values returned for attribute identifier. Defaults to 100.

The pagination token for the previous page of attribute name.

Limit total values returned for attribute name. Defaults to 100.

The pagination token for the next page of attribute status.

The pagination token for the previous page of attribute status.

Filter relationships to relationship type, e.g. director_of or has_shareholder

Limit total values returned for attribute status. Defaults to 100.

Sorts relationships by As Of date or Shareholder percentage, e.g. date or -shares

Filters relationships to a list of countries

Filters shipment relationships to a list of arrival countries

Filters shipment relationships to a list of departure countries

Filters shipment relationships to a trade partner risk tag