Get Project Entity

Beta

GET

/v1/projects/:project_id/entities/:project_entity_id

GET

/v1/projects/:project_id/entities/:project_entity_id

1 curl https://api.sayari.com/v1/projects/project_id/entities/project_entity_id \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "data": {
3     "project_entity_id": "project_entity_id",
4     "project_id": "project_id",
5     "label": "label",
6     "upload_ids": [
7       "upload_ids",
8       "upload_ids"
9     ],
10     "strength": "strong",
11     "created_at": "created_at",
12     "attributes": {
13       "attributes": {
14         "resolve": true,
15         "values": [
16           "values",
17           "values"
18         ]
19       }
20     },
21     "matches": [
22       {
23         "match_id": "match_id",
24         "sayari_entity_id": "sayari_entity_id",
25         "type": "type",
26         "label": "label",
27         "matched_attributes": {
28           "name": [
29             "name",
30             "name"
31           ],
32           "address": [
33             "address",
34             "address"
35           ],
36           "contact": [
37             "contact",
38             "contact"
39           ],
40           "country": [
41             "country",
42             "country"
43           ],
44           "identifier": [
45             "identifier",
46             "identifier"
47           ]
48         },
49         "countries": [
50           "countries",
51           "countries"
52         ],
53         "risks": [
54           "risks",
55           "risks"
56         ],
57         "business_purpose": [
58           {
59             "code": "code",
60             "standard": "standard"
61           },
62           {
63             "code": "code",
64             "standard": "standard"
65           }
66         ],
67         "upstream": {
68           "risks": [
69             "risks",
70             "risks"
71           ],
72           "countries": [
73             "countries",
74             "countries"
75           ],
76           "trade_counts": {
77             "receiver_of": 1,
78             "shipper_of": 1
79           },
80           "has_upstream": true,
81           "products": [
82             "products",
83             "products"
84           ],
85           "risk_counts": {
86             "risk_counts": {
87               "risk_counts": [
88                 {
89                   "count": 1
90                 },
91                 {
92                   "count": 1
93                 }
94               ]
95             }
96           },
97           "country_counts": {
98             "country_counts": {
99               "country_counts": [
100                 {
101                   "count": 1
102                 },
103                 {
104                   "count": 1
105                 }
106               ]
107             }
108           }
109         },
110         "sources": [
111           {
112             "id": "id",
113             "label": "label"
114           },
115           {
116             "id": "id",
117             "label": "label"
118           }
119         ],
120         "addresses": [
121           {
122             "value": "value",
123             "country": "country",
124             "city": "city",
125             "state": "state",
126             "location": {
127               "lat": 1.1,
128               "lon": 1.1
129             }
130           },
131           {
132             "value": "value",
133             "country": "country",
134             "city": "city",
135             "state": "state",
136             "location": {
137               "lat": 1.1,
138               "lon": 1.1
139             }
140           }
141         ],
142         "hs_codes": [
143           "hs_codes",
144           "hs_codes"
145         ],
146         "created_at": "created_at",
147         "updated_at": "updated_at",
148         "resolution_profile": "resolution_profile",
149         "deleted_at": "deleted_at"
150       },
151       {
152         "match_id": "match_id",
153         "sayari_entity_id": "sayari_entity_id",
154         "type": "type",
155         "label": "label",
156         "matched_attributes": {
157           "name": [
158             "name",
159             "name"
160           ],
161           "address": [
162             "address",
163             "address"
164           ],
165           "contact": [
166             "contact",
167             "contact"
168           ],
169           "country": [
170             "country",
171             "country"
172           ],
173           "identifier": [
174             "identifier",
175             "identifier"
176           ]
177         },
178         "countries": [
179           "countries",
180           "countries"
181         ],
182         "risks": [
183           "risks",
184           "risks"
185         ],
186         "business_purpose": [
187           {
188             "code": "code",
189             "standard": "standard"
190           },
191           {
192             "code": "code",
193             "standard": "standard"
194           }
195         ],
196         "upstream": {
197           "risks": [
198             "risks",
199             "risks"
200           ],
201           "countries": [
202             "countries",
203             "countries"
204           ],
205           "trade_counts": {
206             "receiver_of": 1,
207             "shipper_of": 1
208           },
209           "has_upstream": true,
210           "products": [
211             "products",
212             "products"
213           ],
214           "risk_counts": {
215             "risk_counts": {
216               "risk_counts": [
217                 {
218                   "count": 1
219                 },
220                 {
221                   "count": 1
222                 }
223               ]
224             }
225           },
226           "country_counts": {
227             "country_counts": {
228               "country_counts": [
229                 {
230                   "count": 1
231                 },
232                 {
233                   "count": 1
234                 }
235               ]
236             }
237           }
238         },
239         "sources": [
240           {
241             "id": "id",
242             "label": "label"
243           },
244           {
245             "id": "id",
246             "label": "label"
247           }
248         ],
249         "addresses": [
250           {
251             "value": "value",
252             "country": "country",
253             "city": "city",
254             "state": "state",
255             "location": {
256               "lat": 1.1,
257               "lon": 1.1
258             }
259           },
260           {
261             "value": "value",
262             "country": "country",
263             "city": "city",
264             "state": "state",
265             "location": {
266               "lat": 1.1,
267               "lon": 1.1
268             }
269           }
270         ],
271         "hs_codes": [
272           "hs_codes",
273           "hs_codes"
274         ],
275         "created_at": "created_at",
276         "updated_at": "updated_at",
277         "resolution_profile": "resolution_profile",
278         "deleted_at": "deleted_at"
279       }
280     ],
281     "tags": [
282       {
283         "id": "id",
284         "label": "label",
285         "created_at": "created_at",
286         "updated_at": "updated_at"
287       },
288       {
289         "id": "id",
290         "label": "label",
291         "created_at": "created_at",
292         "updated_at": "updated_at"
293       }
294     ],
295     "product_mapping": {
296       "products": [
297         "products",
298         "products"
299       ],
300       "state": "state"
301     },
302     "case": "not_assigned",
303     "updated_at": "updated_at"
304   }
305 }

Retrieves a specific entity in a project.

Path parameters

project_idstringRequired

project_entity_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

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.

dataobject

Get Project Entity

Path parameters

Headers

Query parameters

Response

Errors