Screen

Beta

GET

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

GET

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

$ curl -G https://api.sayari.com/v1/projects/YVB88Y/entities/YVodz6/screen \
>      -H "Authorization: Bearer <token>" \
>      -d type=company

1 {
2   "request": {
3     "project_id": "YVB88Y",
4     "project_entity_id": "YVodz6"
5   },
6   "project_entity_attributes": {
7     "name": {
8       "match_resolution": true,
9       "values": [
10         {
11           "value": "AEROCARIBBEAN AIRLINES"
12         }
13       ]
14     }
15   },
16   "data": [
17     {
18       "reference_id": "ofac-sdn-48846",
19       "org_id": "ofac",
20       "release_name": "2024-01-01",
21       "name_matches": [
22         {
23           "name": "AEROCARIBBEAN AIRLINES",
24           "similarity_score": 0.4,
25           "confidence_score": 0.5,
26           "explanation": "High name similarity with matching organization type"
27         }
28       ],
29       "type": "company",
30       "entity_match": {
31         "entity_reference_id": "ofac-sdn-48846",
32         "type": "company",
33         "additional_information": [
34           {
35             "value": "Designated pursuant to Executive Order 13224",
36             "type": "Designation Basis",
37             "date": null,
38             "to_date": null,
39             "from_date": null,
40             "extra": null
41           }
42         ],
43         "address": [
44           {
45             "value": "Calle 23 No. 64, Havana, Cuba",
46             "city": "Havana",
47             "state": null,
48             "country": "CU",
49             "postcode": "10400",
50             "road": null,
51             "house": "Calle 23 No. 64",
52             "house_number": null,
53             "type": null,
54             "unit": null,
55             "x": null,
56             "y": null,
57             "near": null,
58             "level": null,
59             "building": null,
60             "suburb": null,
61             "island": null,
62             "po_box": null,
63             "entrance": null,
64             "staircase": null,
65             "category": null,
66             "world_region": null,
67             "city_district": null,
68             "metro_station": null,
69             "country_region": null,
70             "state_district": null,
71             "precision_code": null,
72             "date": null,
73             "to_date": null,
74             "from_date": null,
75             "language": null,
76             "translated": null,
77             "transliterated": null,
78             "extra": [
79               {
80                 "key": "Country Field Added By",
81                 "value": "libpostal"
82               }
83             ]
84           }
85         ],
86         "business_purpose": [
87           {
88             "value": "Air transportation",
89             "date": null,
90             "to_date": null,
91             "from_date": null,
92             "extra": null
93           }
94         ],
95         "company_type": [
96           {
97             "value": "State-owned enterprise",
98             "date": null,
99             "to_date": null,
100             "from_date": null,
101             "extra": null
102           }
103         ],
104         "contact": [
105           {
106             "value": "+53 7 835-0216",
107             "type": "phone",
108             "date": null,
109             "to_date": null,
110             "from_date": null,
111             "extra": null
112           },
113           {
114             "value": "[email protected]",
115             "type": "email",
116             "date": null,
117             "to_date": null,
118             "from_date": null,
119             "extra": null
120           }
121         ],
122         "country": [
123           {
124             "value": "CU",
125             "context": "domicile",
126             "state": null,
127             "date": null,
128             "to_date": null,
129             "from_date": null,
130             "extra": null
131           }
132         ],
133         "finances": [
134           {
135             "value": "1500000",
136             "currency": "USD",
137             "type": "share_capital",
138             "date": null,
139             "to_date": null,
140             "from_date": null,
141             "extra": null
142           }
143         ],
144         "financials": [
145           {
146             "value": "12000000",
147             "currency": "USD",
148             "type": "annual_revenue",
149             "year": "2019",
150             "date": null,
151             "to_date": null,
152             "from_date": null,
153             "extra": null
154           }
155         ],
156         "gender": null,
157         "generic": [
158           {
159             "value": "CUBA",
160             "type": "program",
161             "date": null,
162             "to_date": null,
163             "from_date": null,
164             "extra": null
165           }
166         ],
167         "identifier": [
168           {
169             "value": "48846",
170             "type": "SDN ID",
171             "date": null,
172             "to_date": null,
173             "from_date": null,
174             "extra": null
175           },
176           {
177             "value": "CU-1234567",
178             "type": "registration_number",
179             "date": null,
180             "to_date": null,
181             "from_date": null,
182             "extra": null
183           }
184         ],
185         "measurement": [
186           {
187             "value": "750",
188             "unit": "employees",
189             "type": "headcount",
190             "date": null,
191             "to_date": null,
192             "from_date": null,
193             "extra": null
194           }
195         ],
196         "monetary_value": [
197           {
198             "value": "2500000",
199             "currency": "USD",
200             "type": "FOB",
201             "date": null,
202             "to_date": null,
203             "from_date": null,
204             "extra": null
205           }
206         ],
207         "name": [
208           {
209             "value": "AEROCARIBBEAN AIRLINES",
210             "context": "primary",
211             "date": null,
212             "extra": null,
213             "to_date": null,
214             "language": null,
215             "from_date": null,
216             "translated": null,
217             "transliterated": null
218           }
219         ],
220         "person_status": null,
221         "position": [
222           {
223             "value": "Minister of Transportation",
224             "type": "oversight",
225             "date": null,
226             "to_date": null,
227             "from_date": null,
228             "extra": null
229           }
230         ],
231         "risk_intelligence": [
232           {
233             "list": "OFAC Specially Designated Nationals (SDN) List",
234             "type": "sanctioned",
235             "score": null,
236             "reason": null,
237             "program": "CUBA",
238             "authority": "OFAC",
239             "from_date": "2002-01-01",
240             "to_date": null,
241             "date": null,
242             "extra": [
243               {
244                 "key": "License Policy",
245                 "value": "Presumption of denial."
246               }
247             ]
248           }
249         ],
250         "risk_factors": [
251           "sanctioned"
252         ],
253         "shares": [
254           {
255             "value": "100",
256             "unit": "%",
257             "type": "government_owned",
258             "date": null,
259             "to_date": null,
260             "from_date": null,
261             "extra": null
262           }
263         ],
264         "status": [
265           {
266             "value": "active",
267             "date": "2020-01-01",
268             "to_date": null,
269             "from_date": null,
270             "extra": null
271           }
272         ],
273         "translated_name": [
274           {
275             "value": "Aerolíneas AeroCaribbean",
276             "context": null,
277             "date": null,
278             "extra": null,
279             "to_date": null,
280             "language": "es",
281             "from_date": null,
282             "translated": null,
283             "transliterated": null
284           }
285         ],
286         "weak_identifier": [
287           {
288             "value": "AEROCARIBBEAN",
289             "type": "common_name",
290             "date": null,
291             "to_date": null,
292             "from_date": null,
293             "extra": null
294           }
295         ],
296         "risk_event": [
297           {
298             "category": "Law Enforcement",
299             "subcategory": "Sanctions",
300             "event_type": "SDN Designation",
301             "title": "OFAC SDN Designation — CUBA Sanctions Program",
302             "source_url": "https://sanctionssearch.ofac.treas.gov/Details.aspx?id=48846",
303             "credibility": "Official",
304             "event_stage": "Active",
305             "penalty_and_restriction": "Asset freeze; prohibit US persons from transacting",
306             "dismissal_and_clearance": null
307           }
308         ]
309       }
310     }
311   ]
312 }

Screen a project entity against watchlist records to identify potential matches. Requires the screened_risk role.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

project_idstringRequired

Project identifier.

project_entity_idstringRequired

Project entity identifier.

Query parameters

typestringOptional

Comma-separated list of watchlist record types to filter by.

release_namestringOptional

Watchlist release name to filter by.

Response

This endpoint returns an object.

requestobject

project_entity_attributesmap from strings to objects

datalist of objects

Errors

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

406

Not Acceptable

422

Unprocessable Content

429

Rate Limit Exceeded

500

Internal Server Error