Search

Search Entity

POST
Search for an entity. Please note, searches are limited to a maximum of 10,000 results.

Query parameters

limitintegerOptional
A limit on the number of objects to be returned with a range between 1 and 100. Defaults to 100.
offsetintegerOptional
Number of results to skip before returning response. Defaults to 0.

Request

This endpoint expects an object.
q
stringRequired
Query term. The syntax for the query parameter follows elasticsearch simple query string syntax. The includes the ability to use search operators and to perform nested queries. Must be url encoded.
fields
list of enumsOptional
Record or entity fields to search against.
filter
objectOptional
Filters to be applied to search query to limit the result-set.
facets
booleanOptional
Whether or not to return search facets in results giving counts by field. Defaults to false.
geo_facets
booleanOptional
Whether or not to return search geo bound facets in results giving counts by geo tile. Defaults to false.
advanced
booleanOptional
Set to true to enable full elasticsearch query string syntax which allows for fielded search and more complex operators. Note that the syntax is more strict and can result in empty result-sets. Defaults to false.

Response

This endpoint returns an object
data
list of objects
limit
integer
next
boolean
offset
integer
size
object
POST
1curl -X POST "https://api.sayari.com/v1/search/entity?limit=1" \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "q": "victoria beckham limited"
6}'
200
Successful
1{
2 "data": [
3 {
4 "addresses": [
5 "202 HAMMERSMITH ROAD , LONDON , , UNITED KINGDOM , W6 7DN , GB",
6 "Unit 33, Ransomes Dock Business Centre, 35-37 Parkgate Road, London SW11 4NP",
7 "SAUNDERS BUILDING, 202 HAMMERSMITH ROAD, HAMMERSMITH, LONDON"
8 ],
9 "attribute_count": {
10 "company_type": 2,
11 "name": 2,
12 "business_purpose": 4,
13 "identifier": 3,
14 "additional_information": 106,
15 "country": 8,
16 "status": 5,
17 "address": 7
18 },
19 "closed": false,
20 "coordinates": [
21 {
22 "lat": 51.49323,
23 "lng": -0.22207,
24 "address": "202 HAMMERSMITH ROAD , LONDON , , UNITED KINGDOM , W6 7DN , GB"
25 },
26 {
27 "lat": 51.47943,
28 "lng": -0.16859,
29 "address": "Unit 33, Ransomes Dock Business Centre, 35-37 Parkgate Road, London SW11 4NP"
30 },
31 {
32 "lat": 51.49323,
33 "lng": -0.22207,
34 "address": "SAUNDERS BUILDING, 202 HAMMERSMITH ROAD, HAMMERSMITH, LONDON"
35 },
36 {
37 "lat": 51.47898,
38 "lng": -0.16784,
39 "address": "Ransome's Dock, 35-37 Parkgate Road, London, SW11 4NP"
40 },
41 {
42 "lat": 51.493080000000006,
43 "lng": -0.22138000000000002,
44 "address": "Hammersmith Road, London, W6 7DN"
45 },
46 {
47 "lat": 51.49291,
48 "lng": -0.22579,
49 "address": "202 HAMMERSMITH ROAD UNITED KINGDOM"
50 }
51 ],
52 "countries": [
53 "GBR",
54 "USA"
55 ],
56 "degree": 67,
57 "entity_url": "/v1/entity/mGq1lpuqKssNWTjIokuPeA",
58 "id": "mGq1lpuqKssNWTjIokuPeA",
59 "identifiers": [
60 {
61 "value": "06517802",
62 "type": "uk_company_number",
63 "label": "Uk Company Number"
64 },
65 {
66 "value": "6517802",
67 "type": "unknown",
68 "label": "Unknown"
69 },
70 {
71 "value": "04781466",
72 "type": "ca_corporate_id_num",
73 "label": "Ca Corporate Id Num"
74 }
75 ],
76 "label": "VICTORIA BECKHAM LIMITED",
77 "matches": {
78 "name": [
79 "<em>VICTORIA</em> <em>BECKHAM</em> <em>LIMITED</em>",
80 "<em>BECKHAM</em> VENTURES <em>LIMITED</em>",
81 "<em>VICTORIA</em> <em>BECKHAM</em> LIMITED",
82 "<em>BECKHAM</em> VENTURES LIMITED"
83 ]
84 },
85 "pep": false,
86 "psa_count": 3,
87 "related_entities_count": 67,
88 "relationship_count": {
89 "linked_to": 3,
90 "has_officer": 2,
91 "shareholder_of": 1,
92 "has_shareholder": 2,
93 "has_registered_agent": 5,
94 "shipper_of": 41,
95 "has_director": 11,
96 "owner_of": 3,
97 "has_founder": 1,
98 "ships_to": 1
99 },
100 "risk": {
101 "basel_aml": {
102 "value": 4.63,
103 "metadata": {
104 "country": [
105 "USA"
106 ]
107 },
108 "level": "relevant"
109 },
110 "cpi_score": {
111 "value": 67,
112 "metadata": {
113 "country": [
114 "USA"
115 ]
116 },
117 "level": "relevant"
118 }
119 },
120 "sanctioned": false,
121 "source_count": {
122 "2b618f1996252fe537a6d998ae14c9b2": {
123 "count": 1,
124 "label": "UK Corporate Registry Confirmation Statements"
125 },
126 "2b788dbdf9194ed5a5c309386a6516b1": {
127 "count": 28,
128 "label": "UK HM Revenue & Customs Traders Database"
129 },
130 "a447a7b622c4ead6e1caf94983dc2337": {
131 "count": 6,
132 "label": "USA California Secretary of State"
133 },
134 "ecdfb3f2ecc8c3797e77d5795a8066ef": {
135 "count": 35,
136 "label": "UK Corporate Registry"
137 },
138 "e5de7b52cc88ef4cd1a10e201bdf46ee": {
139 "count": 41,
140 "label": "Vietnam Imports & Exports (January 2023 - Present)"
141 },
142 "2a4fe9a14e332c8f9ded1f8a457c2b89": {
143 "count": 36,
144 "label": "UK Land Commercial and Corporate Ownership Data (CCOD)"
145 },
146 "4ea8bac1bed868e1510ffd21842e9551": {
147 "count": 69,
148 "label": "UK Persons with Significant Control"
149 }
150 },
151 "trade_count": {
152 "sent": 41,
153 "received": 0
154 },
155 "type": "company",
156 "user_attribute_count": {},
157 "user_record_count": 0,
158 "user_related_entities_count": 0,
159 "user_relationship_count": {},
160 "company_type": "Stock Corporation - Out of State - Stock",
161 "latest_status": {
162 "status": "active",
163 "date": "2023-08-29"
164 },
165 "psa_id": "695785012897",
166 "reference_id": "ecdfb3f2ecc8c3797e77d5795a8066ef/06517802/1540252800000:4a34442eccf1622995130b194a5d50e7",
167 "registration_date": "Incorporated 2008-02-28"
168 }
169 ],
170 "limit": 1,
171 "next": true,
172 "offset": 0,
173 "size": {
174 "count": 64,
175 "qualifier": "eq"
176 }
177}