Update a screening exception by its ID
Updates the specified screening exception. Only conditional exceptions can be updated, since profile exceptions do not contain any fields that are mutable after they are created.
1{2 "id": "cbd71a01-c0fe-47f4-971b-01e2fbacdfb8",3 "expirationType": "NEVER",4 "conditions": [5 {6 "path": "/party/screeningResult/matchedProfile/tags",7 "operator": "contains",8 "value": "VSL"9 }10 ],11 "status": "ACTIVE",12 "creationTimeStamp": "2024-01-11T20:46:21.883Z",13 "modifiedTimeStamp": "2024-01-11T20:46:21.883Z",14 "version": 1,15 "links": [16 {17 "method": "GET",18 "rel": "up",19 "href": "/watchlistScreening/exceptions",20 "uri": "/watchlistScreening/exceptions",21 "type": "application/vnd.sas.collection",22 "itemType": "application/vnd.sas.watchlist.screening.conditional.exception"23 },24 {25 "method": "GET",26 "rel": "self",27 "href": "/watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8",28 "uri": "/watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8",29 "type": "application/vnd.sas.watchlist.screening.conditional.exception"30 },31 {32 "method": "PUT",33 "rel": "update",34 "href": "/watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8",35 "uri": "/watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8",36 "type": "application/vnd.sas.watchlist.screening.conditional.exception",37 "responseType": "application/vnd.sas.watchlist.screening.conditional.exception"38 },39 {40 "method": "DELETE",41 "rel": "delete",42 "href": "/watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8",43 "uri": "/watchlistScreening/exceptions/cbd71a01-c0fe-47f4-971b-01e2fbacdfb8"44 }45 ]46}
| Name | Type | Required | Description |
|---|---|---|---|
screeningExceptionId | string | true | The ID of the screening exception. |
| Name | Type | Required | Description |
|---|---|---|---|
Accept | string | false | The desired representation for the response. Allowed values: application/vnd.sas.watchlist.screening.conditional.exception+jsonapplication/vnd.sas.watchlist.screening.conditional.exception+json;version=1application/json Default: application/vnd.sas.watchlist.screening.conditional.exception+json |
Content-Type | string | false | The representation for the request. Allowed values: application/vnd.sas.watchlist.screening.conditional.exception+jsonapplication/vnd.sas.watchlist.screening.conditional.exception+json;version=1application/json Default: application/vnd.sas.watchlist.screening.conditional.exception+json |
The screening exception to update.
A conditional exception identifies conditions that do not generate alerts for a screening request during the screening process. A conditional exception applies if the data in a screening request satisfy the conditions specified by the conditional exception. When these conditions are met, the screening result hit is classified as "discarded".
| Name | Type | Required | Description |
|---|---|---|---|
profileId | string | false | The profile ID of the watchlist record that is attached to this exception. This value is immutable after creation. |
match | string | false | The name (or alias) of the watchlist record that should be accepted. When empty, any match with the given profile is managed by this exception. This data is not retained. Instead, a hash is computed and returned in the matchHash field. This value is immutable after creation. If a value is provided, a valid profileId value is required. |
source | string | false | The exact string for which a match is triggered. The exception is active only if the same source is screened again. The matching string is not case sensitive. When empty, any string that triggers the specified match is managed by this exception. This data is not retained. Instead, a hash is computed and returned in the sourceHash field. This value is immutable after creation. If a value is provided, a valid profileId value is required. |
expirationType | string | true | Determines the condition in which this exception should be invalidated: • NEVER: The exception never expires. • DATE: When the scheduled date occurs. • PROFILE: When the profile changes in the watchlist. If this value is provided, a valid profileId value is required. • CORE_PROFILE: When any important profile information has changed in the watchlist. Important profile information includes all the properties that are part of the screening logic. This includes names, addresses, IDs, dates of birth, sanctions, status, etc. If this value is provided, a valid profileId value is required. Allowed values: NEVERDATEPROFILECORE_PROFILE |
expirationDate | string | false | If the expirationType is set to DATE, specifies the expiration date of the exception. This is required if expirationType=DATE. |
profileChecksum | integer | false | The profile checksum (as provided in the screening results) to be used if the expirationType is set to PROFILE. This is required if expirationType=PROFILE. |
coreChecksum | integer | false | The core profile checksum (as provided in the screening results) to be used if the expirationType is set to CORE_PROFILE. This is required if expirationType=CORE_PROFILE. |
prefix | string | false | The text to match that precedes the exact text (source) in order to apply this exception. This is optional. If a value is provided, a valid profileId value is required. |
suffix | string | false | The text to match that follows the exact text (source) in order to apply this exception. This is optional. If a value is provided, a valid profileId value is required. |
conditions | array [object] | false | Additional restrictions on the request or found match for this exception to be applicable. <= 20 items |
| 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 | |
| 415 | Unsupported Media Type | Unsupported Media Type. Include a Content-Type header with a supported value in the request. | Schema | |
| 422 | Unprocessable Entity | UnprocessableEntity. | Schema | |
| 500 | Internal Server Error | The service encountered an error. | Schema | |
| 502 | Bad Gateway | Bad Gateway | Schema |