A collection of entities to be screened and the options to use for this screening request.
Screen a group of entities
post/entity
Performs a screening action on a list of entities.
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 "screeningResult": {26 "discardedHits": 1,27 "hits": 2,28 "matchedProfile": [29 {30 "categories": [31 "(Cat 1) Special Interest Person (SIP)",32 "(Cat 2) Other Official Lists",33 "(Cat 2) Sanctions Lists"34 ],35 "checksum": -1727466793,36 "coreChecksum": -2056675719,37 "dateOfBirth": [38 {39 "birthDay": 13,40 "birthDt": "1960-03-13",41 "birthMonth": 3,42 "birthYear": 196043 }44 ],45 "exceptionId": "665ac66a-7960-498e-aaf5-0c4a6e2d188b",46 "level": "discarded",47 "links": [48 {49 "method": "GET",50 "rel": "profile",51 "href": "/watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793",52 "uri": "/watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793",53 "type": "application/json"54 },55 {56 "method": "GET",57 "rel": "exception",58 "href": "/watchlistScreening/exceptions/665ac66a-7960-498e-aaf5-0c4a6e2d188b",59 "uri": "/watchlistScreening/exceptions/665ac66a-7960-498e-aaf5-0c4a6e2d188b",60 "type": "application/vnd.sas.watchlist.screening.conditional.exception"61 }62 ],63 "matchType": "/name/primary",64 "matchedName": "Ashworth, Oscar Heath",65 "primaryName": "Ashworth, Oscar Heath",66 "profileBirthPlaces": [67 {68 "city": "phoenix",69 "countryCode": "us"70 }71 ],72 "profileId": "HMT0000000013272",73 "profileLastUpdated": "2024-02-20T01:00:01.163Z",74 "profilePlaces": [75 {76 "city": "Pine Bay",77 "countryCode": "us"78 }79 ],80 "profileGender": "male",81 "profileRelatedCountries": [82 "us"83 ],84 "profileStatus": "UNK",85 "profileType": "individual",86 "sanctions": [87 "HMT"88 ],89 "score": 98,90 "scoreScope": [91 "COUNTRY",92 "DOB",93 "NAME"94 ],95 "screened": "Ashworth, Oscar Heath",96 "tags": [97 "SAN"98 ]99 },100 {101 "categories": [102 "MUR"103 ],104 "checksum": -1871588783,105 "coreChecksum": -662103456,106 "dateOfBirth": [107 {108 "birthDay": 13,109 "birthDt": "1960-03-13",110 "birthMonth": 3,111 "birthYear": 1960112 }113 ],114 "level": "medium",115 "links": [116 {117 "method": "GET",118 "rel": "profile",119 "href": "/watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783",120 "uri": "/watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783",121 "type": "application/json"122 }123 ],124 "matchType": "/name/alias",125 "matchedName": "Ashworth, Heath",126 "primaryName": "Ashworth, Oscar",127 "profileId": "OFAC000000018428",128 "profileLastUpdated": "2024-02-20T01:15:01.163Z",129 "profilePlaces": [130 {131 "city": "Pine Bay",132 "countryCode": "us"133 }134 ],135 "profileRelatedCountries": [136 "us"137 ],138 "profileStatus": "UNK",139 "profileType": "individual",140 "proximityScore": 100,141 "sanctions": [142 "OFACSD"143 ],144 "score": 98,145 "scoreScope": [146 "COUNTRY",147 "DOB",148 "NAME"149 ],150 "screened": "Ashworth, Oscar Heath",151 "tags": [152 "SAN"153 ]154 }155 ],156 "messageReference": "120ef864-3e6b-423f-a8cb-307a3fc6d6af",157 "statusCode": "Success"158 },159 "type": "individual"160 },161 {162 "dateOfBirth": [163 {164 "birthDt": "1941-05-24"165 }166 ],167 "gender": "male",168 "identifier": "00002",169 "address": [170 {171 "category": "pob",172 "city": "estes park",173 "countryCode": "usa"174 }175 ],176 "name": "Smith, James",177 "screeningResult": {178 "discardedHits": 0,179 "hits": 0,180 "messageReference": "120ef864-3e6b-423f-a8cb-307a3fc6d6af",181 "statusCode": "Success"182 },183 "type": "individual"184 },185 {186 "identifier": "000003",187 "name": "Sanctioned Airlines",188 "screeningResult": {189 "discardedHits": 0,190 "hits": 1,191 "matchedProfile": [192 {193 "categories": [194 "CUBA"195 ],196 "checksum": -2108164488,197 "coreChecksum": 576052857,198 "level": "low",199 "links": [200 {201 "method": "GET",202 "rel": "profile",203 "href": "/watchlistScreening/profiles/OFAC000000000036?checksum=-2108164488",204 "uri": "/watchlistScreening/profiles/OFAC000000000036?checksum=-2108164488",205 "type": "application/json"206 }207 ],208 "matchType": "/name/primary",209 "matchedName": "Sanctioned Airlines",210 "primaryName": "Sanctioned Airlines",211 "profileId": "OFAC000000000036",212 "profileLastUpdated": "2024-02-20T01:00:01.163Z",213 "profilePlaces": [214 {215 "city": "Havana",216 "countryCode": "cu"217 }218 ],219 "profileRelatedCountries": [220 "cu"221 ],222 "profileStatus": "UNK",223 "profileType": "entity",224 "proximityScore": 100,225 "score": 100,226 "scoreScope": [227 "NAME"228 ],229 "screened": "Sanctioned Airlines",230 "tags": [231 "SAN"232 ]233 }234 ],235 "messageReference": "120ef864-3e6b-423f-a8cb-307a3fc6d6af",236 "statusCode": "Success"237 },238 "type": "entity"239 }240 ],241 "screeningOptions": {242 "chnEntity": "sample_chn_realtime_entity",243 "chnIndividual": "sample_chn_realtime_individual",244 "chnUnknown": "sample_chn_realtime_unknown",245 "messageReference": "120ef864-3e6b-423f-a8cb-307a3fc6d6af"246 }247 }248}| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | The request succeeded. | Headers | Schema |
| 400 | Bad Request | Bad request (the request is not well-formed). | Schema | |
| 403 | Forbidden | The request is forbidden because the license is not active. | Schema | |
| 404 | Not Found | The service is not available. | Schema | |
| 406 | Not Acceptable | Not Acceptable. Include an Accept header with a supported value on the request. | Schema | |
| 408 | Request Timeout | Request timeout. | Schema | |
| 415 | Unsupported Media Type | Unsupported Media Type. Include a Content-Type header with a supported value in the request. | Schema | |
| 502 | Bad Gateway | Bad Gateway | Schema | |
| 503 | Service Unavailable | Service Unavailable | Schema |