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