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>"

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         "match_resolution": true,
15         "values": [
16           "values",
17           "values"
18         ]
19       }
20     },
21     "countries": [
22       "countries",
23       "countries"
24     ],
25     "risk_categories": [
26       {
27         "id": "id",
28         "label": "label",
29         "risk_factors": [
30           "risk_factors",
31           "risk_factors"
32         ]
33       },
34       {
35         "id": "id",
36         "label": "label",
37         "risk_factors": [
38           "risk_factors",
39           "risk_factors"
40         ]
41       }
42     ],
43     "risk_factors": [
44       {
45         "id": "id"
46       },
47       {
48         "id": "id"
49       }
50     ],
51     "upstream": {
52       "risk_factors": [
53         {
54           "id": "id"
55         },
56         {
57           "id": "id"
58         }
59       ],
60       "countries": [
61         "countries",
62         "countries"
63       ],
64       "trade_counts": {
65         "receiver_of": 1,
66         "shipper_of": 1
67       },
68       "has_upstream": true,
69       "products": [
70         "products",
71         "products"
72       ],
73       "risk_counts": {
74         "risk_counts": {
75           "risk_counts": [
76             {
77               "count": 1,
78               "product": "product"
79             },
80             {
81               "count": 1,
82               "product": "product"
83             }
84           ]
85         }
86       },
87       "country_counts": {
88         "country_counts": {
89           "country_counts": [
90             {
91               "count": 1,
92               "product": "product"
93             },
94             {
95               "count": 1,
96               "product": "product"
97             }
98           ]
99         }
100       }
101     },
102     "tags": [
103       {
104         "id": "id",
105         "label": "label",
106         "created_at": "created_at",
107         "updated_at": "updated_at"
108       },
109       {
110         "id": "id",
111         "label": "label",
112         "created_at": "created_at",
113         "updated_at": "updated_at"
114       }
115     ],
116     "matches": [
117       {
118         "match_id": "match_id",
119         "sayari_entity_id": "sayari_entity_id",
120         "type": "type",
121         "label": "label",
122         "countries": [
123           "countries",
124           "countries"
125         ],
126         "risk_categories": [
127           {
128             "id": "id",
129             "label": "label",
130             "risk_factors": [
131               "risk_factors",
132               "risk_factors"
133             ]
134           },
135           {
136             "id": "id",
137             "label": "label",
138             "risk_factors": [
139               "risk_factors",
140               "risk_factors"
141             ]
142           }
143         ],
144         "risk_factors": [
145           {
146             "id": "id"
147           },
148           {
149             "id": "id"
150           }
151         ],
152         "business_purpose": [
153           {
154             "code": "code",
155             "standard": "standard"
156           },
157           {
158             "code": "code",
159             "standard": "standard"
160           }
161         ],
162         "upstream": {
163           "risk_factors": [
164             {
165               "id": "id"
166             },
167             {
168               "id": "id"
169             }
170           ],
171           "countries": [
172             "countries",
173             "countries"
174           ],
175           "trade_counts": {
176             "receiver_of": 1,
177             "shipper_of": 1
178           },
179           "has_upstream": true,
180           "products": [
181             "products",
182             "products"
183           ],
184           "risk_counts": {
185             "risk_counts": {
186               "risk_counts": [
187                 {
188                   "count": 1
189                 },
190                 {
191                   "count": 1
192                 }
193               ]
194             }
195           },
196           "country_counts": {
197             "country_counts": {
198               "country_counts": [
199                 {
200                   "count": 1
201                 },
202                 {
203                   "count": 1
204                 }
205               ]
206             }
207           }
208         },
209         "sources": [
210           {
211             "id": "id",
212             "label": "label"
213           },
214           {
215             "id": "id",
216             "label": "label"
217           }
218         ],
219         "addresses": [
220           {
221             "value": "value",
222             "country": "country",
223             "city": "city",
224             "state": "state",
225             "location": {
226               "lat": 1.1,
227               "lon": 1.1
228             }
229           },
230           {
231             "value": "value",
232             "country": "country",
233             "city": "city",
234             "state": "state",
235             "location": {
236               "lat": 1.1,
237               "lon": 1.1
238             }
239           }
240         ],
241         "hs_codes": [
242           "hs_codes",
243           "hs_codes"
244         ],
245         "created_at": "created_at",
246         "updated_at": "updated_at",
247         "match_profile": "corporate",
248         "deleted_at": "deleted_at",
249         "match_explanation": [
250           {
251             "field": "field",
252             "quality": "high",
253             "description": [
254               "description",
255               "description"
256             ],
257             "matches": [
258               "matches",
259               "matches"
260             ]
261           },
262           {
263             "field": "field",
264             "quality": "high",
265             "description": [
266               "description",
267               "description"
268             ],
269             "matches": [
270               "matches",
271               "matches"
272             ]
273           }
274         ]
275       },
276       {
277         "match_id": "match_id",
278         "sayari_entity_id": "sayari_entity_id",
279         "type": "type",
280         "label": "label",
281         "countries": [
282           "countries",
283           "countries"
284         ],
285         "risk_categories": [
286           {
287             "id": "id",
288             "label": "label",
289             "risk_factors": [
290               "risk_factors",
291               "risk_factors"
292             ]
293           },
294           {
295             "id": "id",
296             "label": "label",
297             "risk_factors": [
298               "risk_factors",
299               "risk_factors"
300             ]
301           }
302         ],
303         "risk_factors": [
304           {
305             "id": "id"
306           },
307           {
308             "id": "id"
309           }
310         ],
311         "business_purpose": [
312           {
313             "code": "code",
314             "standard": "standard"
315           },
316           {
317             "code": "code",
318             "standard": "standard"
319           }
320         ],
321         "upstream": {
322           "risk_factors": [
323             {
324               "id": "id"
325             },
326             {
327               "id": "id"
328             }
329           ],
330           "countries": [
331             "countries",
332             "countries"
333           ],
334           "trade_counts": {
335             "receiver_of": 1,
336             "shipper_of": 1
337           },
338           "has_upstream": true,
339           "products": [
340             "products",
341             "products"
342           ],
343           "risk_counts": {
344             "risk_counts": {
345               "risk_counts": [
346                 {
347                   "count": 1
348                 },
349                 {
350                   "count": 1
351                 }
352               ]
353             }
354           },
355           "country_counts": {
356             "country_counts": {
357               "country_counts": [
358                 {
359                   "count": 1
360                 },
361                 {
362                   "count": 1
363                 }
364               ]
365             }
366           }
367         },
368         "sources": [
369           {
370             "id": "id",
371             "label": "label"
372           },
373           {
374             "id": "id",
375             "label": "label"
376           }
377         ],
378         "addresses": [
379           {
380             "value": "value",
381             "country": "country",
382             "city": "city",
383             "state": "state",
384             "location": {
385               "lat": 1.1,
386               "lon": 1.1
387             }
388           },
389           {
390             "value": "value",
391             "country": "country",
392             "city": "city",
393             "state": "state",
394             "location": {
395               "lat": 1.1,
396               "lon": 1.1
397             }
398           }
399         ],
400         "hs_codes": [
401           "hs_codes",
402           "hs_codes"
403         ],
404         "created_at": "created_at",
405         "updated_at": "updated_at",
406         "match_profile": "corporate",
407         "deleted_at": "deleted_at",
408         "match_explanation": [
409           {
410             "field": "field",
411             "quality": "high",
412             "description": [
413               "description",
414               "description"
415             ],
416             "matches": [
417               "matches",
418               "matches"
419             ]
420           },
421           {
422             "field": "field",
423             "quality": "high",
424             "description": [
425               "description",
426               "description"
427             ],
428             "matches": [
429               "matches",
430               "matches"
431             ]
432           }
433         ]
434       }
435     ],
436     "case": {
437       "id": "id",
438       "status": "not_assigned",
439       "created_at": "created_at",
440       "comment": "comment"
441     },
442     "updated_at": "updated_at",
443     "updated_by": "updated_by"
444   }
445 }

Retrieves a specific entity in a project.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

project_idstringRequired

project_entity_idstringRequired

Response

This endpoint returns an object.

dataobject

Errors

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

429

Rate Limit Exceeded

500

Internal Server Error