2.3 Output Fields for Real-Time Screening
This section lists the mandatory output fields received in the real-time process.
The following table lists the Individual or entity output fields in order, the data
format expected for each field, and description.
Table 2-3 Output Fields for Real-Time Screening
JSON Field Name | Expected Data Format | Maximum Character Length | Description |
---|---|---|---|
STATUS | String | 10 |
This field will confirm whether the API response is MATCH_FOUND or NOMATCH_FOUND. If the status is MATCH_FOUND, alert or case is created. If the status is NOMATCH_FOUND, which indicates there is no match generated from the EDQ. |
caseID | String | 15 | This field indicates the generated Alert Id or Case Id. |
caseLink | String | No restriction | This field indicates the link to view the generated Alert or Case. |
type | String | 20 | This field indicates the type of generated Alert or Case. (SAN, PEP or EDD) |
alerts | JSON Array | No restriction | This field contains an array of events generated for the request. |
ListRecordType | String | 300 | This field indicates the matched watchlist record type for the request. |
ListKey | String | 300 | This field indicates the matched watchlist key for the request. |
ListSubKey | String | 300 | This field indicates the matched watchlist sub key for the request. |
ListId | String | 300 | This field indicates the matched watchlist Id for the request. |
MatchScore | Number | 3 | This field indicates the match score of the event. |
score | String | 3 | This field indicates the highest score of all the event match scores. |
WatchlistHashKey | String | 3000 | This field indicates the hash key value generated by EDQ for the matched watchlist details. |
ListRecordOrigin | String | 3000 | This field indicates the matched watchlist record origin for the request. |
RequestHashKey | String | 3000 | This field indicates the hash key value generated by EDQ for the scanned request. |
alertID | Number | 22 | This field indicates the unique value generated for the event. |
watchlistDetail | JSON Array | No restriction | This field contains an array element of all the watchlist details. |
matches | JSON Array | No restriction | This field contains an array element of all matches for the scanned request. |
requestID | String | 20 | This field indicates the unique value generated for the request. |
matchID | Number | 20 | This field indicates the unique value generated for the match. |
matchDetail | JSON Object | No restriction | This filed contains an array element of all the match details for that particular match. |
Note:
The Response will also contain additional watchlist details.