Screen a group of entities

post/entity

Performs a screening action on a list of entities.

Request Samples

1

Response Samples

1{
2 "message": {
3 "party": [
4 {
5 "dateOfBirth": [
6 {
7 "birthDt": "1960-03-13"
8 }
9 ],
10 "gender": "male",
11 "identifier": "00001",
12 "identity": [
13 {
14 "number": "00001"
15 }
16 ],
17 "address": [
18 {
19 "category": "address",
20 "city": "white pines bay",
21 "countryCode": "usa"
22 }
23 ],
24 "name": "Ashworth, Oscar Heath",
25 "alert": {
26 "comment": "sanctions alert generated on SAN match",
27 "screeningOutcome": "Alerted",
28 "type": "SAN"
29 },
30 "screeningResult": {
31 "discardedHits": 1,
32 "hits": 2,
33 "remainingHits": 1,
34 "maxScore": 98,
35 "primaryName": "Ashworth, Oscar Heath",
36 "matchedName": "Ashworth, Oscar Heath",
37 "maxProximityScore": 100,
38 "tags": [
39 "SAN"
40 ],
41 "matchedProfile": [
42 {
43 "alert": {
44 "comment": "alert was excluded",
45 "screeningOutcome": "Excluded"
46 },
47 "categories": [
48 "(Cat 1) Special Interest Person (SIP)",
49 "(Cat 2) Other Official Lists",
50 "(Cat 2) Sanctions Lists"
51 ],
52 "checksum": -1727466793,
53 "coreChecksum": -2056675719,
54 "dateOfBirth": [
55 {
56 "birthDay": 13,
57 "birthDt": "1960-03-13",
58 "birthMonth": 3,
59 "birthYear": 1960
60 }
61 ],
62 "exceptionId": "665ac66a-7960-498e-aaf5-0c4a6e2d188b",
63 "exceptionReference": "CE_2c59e01d-5ed7-427d-a153-f304a0f2d899,",
64 "level": "discarded",
65 "links": [
66 {
67 "method": "GET",
68 "rel": "profile",
69 "href": "/watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793",
70 "uri": "/watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793",
71 "type": "application/json"
72 },
73 {
74 "method": "GET",
75 "rel": "exception",
76 "href": "/watchlistScreening/exceptions/665ac66a-7960-498e-aaf5-0c4a6e2d188b",
77 "uri": "/watchlistScreening/exceptions/665ac66a-7960-498e-aaf5-0c4a6e2d188b",
78 "type": "application/vnd.sas.watchlist.screening.conditional.exception"
79 }
80 ],
81 "locationFrom": 0,
82 "locationPath": "/",
83 "locationTo": 21,
84 "matchType": "/name/primary",
85 "matchedName": "Ashworth, Oscar Heath",
86 "primaryName": "Ashworth, Oscar Heath",
87 "mediaAgeScore": 0,
88 "mediaQuantityScore\"": 98,
89 "profileBirthPlaces": [
90 {
91 "city": "phoenix",
92 "countryCode": "us"
93 }
94 ],
95 "profileId": "HMT0000000013272",
96 "profileLastUpdated": "2024-02-20T01:00:01.163Z",
97 "profilePlaces": [
98 {
99 "city": "Pine Bay",
100 "countryCode": "us"
101 }
102 ],
103 "profileGender": "male",
104 "profileRelatedCountries": [
105 "us"
106 ],
107 "profileStatus": "UNK",
108 "profileType": "individual",
109 "proximityScore": 100,
110 "sanctions": [
111 "HMT"
112 ],
113 "score": 98,
114 "scoreScope": [
115 "COUNTRY",
116 "DOB",
117 "NAME"
118 ],
119 "screened": "Ashworth, Oscar Heath",
120 "tags": [
121 "SAN"
122 ]
123 },
124 {
125 "alert": {
126 "screeningOutcome": "Alerted",
127 "comment": "sanctions alert generated on SAN match"
128 },
129 "categories": [
130 "MUR"
131 ],
132 "checksum": -1871588783,
133 "coreChecksum": -662103456,
134 "dateOfBirth": [
135 {
136 "birthDay": 13,
137 "birthDt": "1960-03-13",
138 "birthMonth": 3,
139 "birthYear": 1960
140 }
141 ],
142 "level": "medium",
143 "links": [
144 {
145 "method": "GET",
146 "rel": "profile",
147 "href": "/watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783",
148 "uri": "/watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783",
149 "type": "application/json"
150 }
151 ],
152 "locationFrom": 0,
153 "locationPath": "/",
154 "locationTo": 21,
155 "matchType": "/name/alias",
156 "matchedName": "Ashworth, Heath",
157 "primaryName": "Ashworth, Oscar",
158 "mediaAgeScore": 0,
159 "mediaQuantityScore\"": 36,
160 "profileId": "OFAC000000018428",
161 "profileLastUpdated": "2024-02-20T01:15:01.163Z",
162 "profilePlaces": [
163 {
164 "city": "Pine Bay",
165 "countryCode": "us"
166 }
167 ],
168 "profileRelatedCountries": [
169 "us"
170 ],
171 "profileStatus": "UNK",
172 "profileType": "individual",
173 "proximityScore": 100,
174 "sanctions": [
175 "OFACSD"
176 ],
177 "score": 98,
178 "scoreScope": [
179 "COUNTRY",
180 "DOB",
181 "NAME"
182 ],
183 "screened": "Ashworth, Oscar Heath",
184 "tags": [
185 "SAN"
186 ]
187 }
188 ],
189 "messageReference": "120ef864-3e6b-423f-a8cb-307a3fc6d6af",
190 "statusCode": "Success"
191 },
192 "type": "individual"
193 },
194 {
195 "dateOfBirth": [
196 {
197 "birthDt": "1941-05-24"
198 }
199 ],
200 "gender": "male",
201 "identifier": "00002",
202 "address": [
203 {
204 "category": "pob",
205 "city": "estes park",
206 "countryCode": "usa"
207 }
208 ],
209 "alert": {
210 "comment": "no hits returned",
211 "screeningOutcome": "No Alert",
212 "type": null
213 },
214 "name": "Smith, James",
215 "screeningResult": {
216 "discardedHits": 0,
217 "hits": 0,
218 "remainingHits": 0,
219 "messageReference": "120ef864-3e6b-423f-a8cb-307a3fc6d6af",
220 "statusCode": "Success"
221 },
222 "type": "individual"
223 },
224 {
225 "identifier": "000003",
226 "name": "Sanctioned Airlines",
227 "alert": {
228 "comment": "sanctions alert generated on SAN match",
229 "screeningOutcome": "Alerted",
230 "type": "SAN"
231 },
232 "screeningResult": {
233 "discardedHits": 0,
234 "hits": 1,
235 "remainingHits": 1,
236 "maxScore": 98,
237 "primaryName": "Sanctioned Airlines",
238 "matchedName": "Sanctioned Airlines",
239 "maxProximityScore": 100,
240 "tags": [
241 "SAN"
242 ],
243 "matchedProfile": [
244 {
245 "alert": {
246 "comment": "sanctions alert generated on SAN match",
247 "screeningOutcome": "Alerted"
248 },
249 "categories": [
250 "CUBA"
251 ],
252 "checksum": -2108164488,
253 "coreChecksum": 576052857,
254 "level": "low",
255 "locationFrom": 0,
256 "locationPath": "/",
257 "locationTo": 19,
258 "links": [
259 {
260 "method": "GET",
261 "rel": "profile",
262 "href": "/watchlistScreening/profiles/OFAC000000000036?checksum=-2108164488",
263 "uri": "/watchlistScreening/profiles/OFAC000000000036?checksum=-2108164488",
264 "type": "application/json"
265 }
266 ],
267 "matchType": "/name/primary",
268 "matchedName": "Sanctioned Airlines",
269 "primaryName": "Sanctioned Airlines",
270 "mediaAgeScore": 0,
271 "mediaQuantityScore\"": 58,
272 "profileId": "OFAC000000000036",
273 "profileLastUpdated": "2024-02-20T01:00:01.163Z",
274 "profilePlaces": [
275 {
276 "city": "Havana",
277 "countryCode": "cu"
278 }
279 ],
280 "profileRelatedCountries": [
281 "cu"
282 ],
283 "profileStatus": "UNK",
284 "profileType": "entity",
285 "proximityScore": 100,
286 "score": 100,
287 "scoreScope": [
288 "NAME"
289 ],
290 "screened": "Sanctioned Airlines",
291 "tags": [
292 "SAN"
293 ]
294 }
295 ],
296 "messageReference": "120ef864-3e6b-423f-a8cb-307a3fc6d6af",
297 "statusCode": "Success"
298 },
299 "type": "entity"
300 }
301 ],
302 "screeningOptions": {
303 "chnEntity": "sample_chn_realtime_entity",
304 "chnIndividual": "sample_chn_realtime_individual",
305 "chnUnknown": "sample_chn_realtime_unknown",
306 "routingClassification": "real-time",
307 "messageReference": "120ef864-3e6b-423f-a8cb-307a3fc6d6af"
308 }
309 }
310}

Request Body

A collection of entities to be screened and the options to use for this screening request.

The collection of objects that are required to screen an entity. This is the default configuration. This request is based on a message schema and might change after deployment.

NameTypeRequiredDescription
message
object
false

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

Bad request (the request is not well-formed).

Schema
403Forbidden

The request is forbidden because the license is not active.

Schema
404Not Found

The service is not available.

Schema
406Not Acceptable

Not Acceptable. Include an Accept header with a supported value on the request.

Schema
408Request Timeout

Request timeout.

Schema
415Unsupported Media Type

Unsupported Media Type. Include a Content-Type header with a supported value in the request.

Schema
502Bad Gateway

Bad Gateway

Schema
503Service Unavailable

Service Unavailable

Schema