Get a screened entity by its party identifier

get/entity/{partyId}

Returns the requested screened entity data. This data is the latest screened data that is associated with the specified entity.

Request Samples

1

Response Samples

1{
2 "processingTimestamp": "2025-01-18T19:19:27.849000Z",
3 "links": [
4 {
5 "href": "/watchlistScreening/entity/00001",
6 "method": "GET",
7 "rel": "self",
8 "type": "application/json",
9 "uri": "/watchlistScreening/entity/00001"
10 }
11 ],
12 "party": {
13 "dateofbirth": [
14 {
15 "birthDay": 3,
16 "birthDt": "1960-03-13T00:00:00Z",
17 "birthYear": 1960
18 },
19 {
20 "birthDay": 13,
21 "birthMonth": 3,
22 "birthYear": 1962
23 }
24 ],
25 "firstName": "Oscar Heath",
26 "gender": "male",
27 "identifier": "00001",
28 "identity": [
29 {
30 "countryOfIssue": 840,
31 "number": "00001"
32 }
33 ],
34 "incomeStatusType": "UHW",
35 "language": 840,
36 "languageCode": "USA",
37 "address": [
38 {
39 "category": "pob",
40 "city": "white pines bay",
41 "countryCode": "us"
42 }
43 ],
44 "name": "Ashworth, Oscar Heath",
45 "screeningResult": {
46 "discardedHits": 0,
47 "hits": 2,
48 "remainingHits": 2,
49 "matchedProfile": [
50 {
51 "alert": {
52 "comment": "sanctions alert generated on SAN match",
53 "screeningOutcome": "Alerted"
54 },
55 "categories": [
56 "(Cat 1) Special Interest Person (SIP)",
57 "(Cat 2) Other Official Lists",
58 "(Cat 2) Sanctions Lists"
59 ],
60 "checksum": -1727466793,
61 "coreChecksum": -2056675719,
62 "dateOfBirth": [
63 {
64 "birthDay": 13,
65 "birthDt": "1960-03-13",
66 "birthMonth": 3,
67 "birthYear": 1960
68 }
69 ],
70 "exceptionId": "665ac66a-7960-498e-aaf5-0c4a6e2d188b",
71 "level": "discarded",
72 "links": [
73 {
74 "method": "GET",
75 "rel": "profile",
76 "href": "/watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793",
77 "uri": "/watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793",
78 "type": "application/json"
79 },
80 {
81 "method": "GET",
82 "rel": "exception",
83 "href": "/watchlistScreening/exceptions/665ac66a-7960-498e-aaf5-0c4a6e2d188b",
84 "uri": "/watchlistScreening/exceptions/665ac66a-7960-498e-aaf5-0c4a6e2d188b",
85 "type": "application/vnd.sas.watchlist.screening.conditional.exception"
86 }
87 ],
88 "matchType": "/name/primary",
89 "matchedName": "Ashworth, Oscar Heath",
90 "primaryName": "Ashworth, Oscar Heath",
91 "profileBirthPlaces": [
92 {
93 "city": "phoenix",
94 "countryCode": "us"
95 }
96 ],
97 "profileId": "HMT0000000013272",
98 "profileLastUpdated": "2024-02-20T01:00:01.163Z",
99 "profilePlaces": [
100 {
101 "city": "Pine Bay",
102 "countryCode": "us"
103 }
104 ],
105 "profileGender": "male",
106 "profileRelatedCountries": [
107 "us"
108 ],
109 "profileStatus": "UNK",
110 "profileType": "individual",
111 "sanctions": [
112 "HMT"
113 ],
114 "score": 98,
115 "scoreScope": [
116 "COUNTRY",
117 "DOB",
118 "NAME"
119 ],
120 "screened": "Ashworth, Oscar Heath",
121 "tags": [
122 "SAN"
123 ]
124 },
125 {
126 "alert": {
127 "comment": "sanctions alert generated on SAN match",
128 "screeningOutcome": "Alerted"
129 },
130 "categories": [
131 "MUR"
132 ],
133 "checksum": -1871588783,
134 "coreChecksum": -662103456,
135 "dateOfBirth": [
136 {
137 "birthDay": 13,
138 "birthDt": "1960-03-13",
139 "birthMonth": 3,
140 "birthYear": 1960
141 }
142 ],
143 "level": "medium",
144 "links": [
145 {
146 "method": "GET",
147 "rel": "profile",
148 "href": "/watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783",
149 "uri": "/watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783",
150 "type": "application/json"
151 }
152 ],
153 "matchType": "/name/alias",
154 "matchedName": "Ashworth, Heath",
155 "primaryName": "Ashworth, Oscar",
156 "profileId": "OFAC000000018428",
157 "profileLastUpdated": "2024-02-20T01:15:01.163Z",
158 "profilePlaces": [
159 {
160 "city": "Pine Bay",
161 "countryCode": "us"
162 }
163 ],
164 "profileRelatedCountries": [
165 "us"
166 ],
167 "profileStatus": "UNK",
168 "profileType": "individual",
169 "proximityScore": 100,
170 "sanctions": [
171 "OFACSD"
172 ],
173 "score": 98,
174 "scoreScope": [
175 "COUNTRY",
176 "DOB",
177 "NAME"
178 ],
179 "screened": "Ashworth, Oscar Heath",
180 "tags": [
181 "SAN"
182 ]
183 }
184 ],
185 "messageReference": "9e5242c1-a55e-47ec-8078-625938f05dd9",
186 "statusCode": "Success"
187 },
188 "surname": "Ashworth",
189 "type": "individual",
190 "vipFlg": false
191 }
192}

Path Parameters

NameTypeRequiredDescription
partyId
string
true

The party identifier of the screened entity.

>= 5 characters<= 100 characters

Header Parameters

NameTypeRequiredDescription
Accept
string
false

The desired representation for the response.

Allowed value:
application/json
Default:
application/json

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

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

Schema
404Not Found

The specified resource was not found.

Schema
406Not Acceptable

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

Schema
500Internal Server Error

The service encountered an error.

Schema