W2 DocsCase Alerts
Case Alert
The endpoints below will make use of the following objects described in this section.
Case Alert
json
{
"alertStatus": "string",
"serviceName": "string",
"caseId": "string",
"caseName": "string",
"caseDayOfBirth": 0,
"caseMonthOfBirth": 0,
"caseYearOfBirth": 0,
"matchedName": "string",
"matchedDayOfBirth": 0,
"matchedMonthOfBirth": 0,
"matchedYearOfBirth": 0,
"dateCreated": "2024-09-12T20:29:46.235Z",
"dateLastUpdated": "2024-09-12T20:29:46.235Z",
"dobMatchScore": 0,
"nameMatchScore": 0,
"profileId": "string",
"screeningId": 0,
"accountName": "string",
"alertId": 0,
"categories": [
"string"
],
"callReference": "string",
"source": "string"
}Case Alert Breakdown
| Property Name | Type | Notes |
|---|---|---|
| AlertStatus | String | The alert status of the alert. Can be one of the following:NewAlertHighRiskMediumRiskLowRiskFalsePositive |
| ServiceName | String | The service associated with the alert. |
| CaseId | String | The CaseId associated with the alert. |
| CaseName | String | The name associated with the case the alert was generated for. |
| CaseDayOfBirth | Integer | The day of birth associated with the case the alert was generated for. |
| CaseMonthOfBirth | Integer | The month of birth associated with the case the alert was generated for. |
| CaseYearOfBirth | Integer | The year of birth associated with the case the alert was generated for. |
| MatchedName | String | The name associated with the alert that was generated. |
| MatchedDayOfBirth | Integer | The day of birth associated with the alert that was generated. |
| MatchedMonthOfBirth | Integer | The month of birth associated with the alert that was generated. |
| MatchedYearOfBirth | Integer | The year of birth associated with the alert that was generated. |
| DateCreated | String | The DateTime when the alert was created. |
| DateLastUpdated | String | The DateTime when the alert was last updated. |
| RecordId | Integer | The record id associated with the alert. |
| DobMatchScore | Integer | The score of the matched date of birth. |
| NameMatchScore | Integer | The score of the matched name. |
| Urn | String | The Urn associated with the alert. |
| ProfileId | String | The ProfileId associated with the alert that was matched against the request data. |
| ScreeningId | Integer | If the alert was generated from our monitoring solution, this will be the id of the screening that generated the alert. |
| AccountName | String | The name of the account that the alert was generated from. |
| AlertId | Integer | The id of the generated alert. |
| Categories | Array of String | An array of strings. |
| CallReference | String | The call reference of the request that generated the alert. |
| Source | String | The source of where the alert was generated. |
Get Case Alerts
The section below describes how to call the Get Case Alerts endpoint.
How to use
To call the endpoint you will need to perform a HTTP GET request to the URL:
| Url | API Version |
|---|---|
| https://api.w2globaldata.com/cases/alerts | 2.8+ |
Pagination Options
There are two pagination options that can be provided in the query string.
- PageNumber
- PageSize
The page size is the number of results we wish to return per page. The page size has a range of 1-100. The page number is the zero-based index of the page we wish to return.
Example Response
The following will be returned if the request was successful.
json
{
"caseAlerts": [
{
"alertStatus": "string: NewAlert|HighRisk|MediumRisk|LowRisk|FalsePositive",
"serviceName": "string",
"caseId": "string",
"caseName": "string",
"caseDayOfBirth": 0,
"caseMonthOfBirth": 0,
"caseYearOfBirth": 0,
"matchedName": "string",
"matchedDayOfBirth": 0,
"matchedMonthOfBirth": 0,
"matchedYearOfBirth": 0,
"dateCreated": "0001-09-12T14:27:13.504Z",
"dateLastUpdated": "0001-09-12T14:27:13.504Z",
"dobMatchScore": 0,
"nameMatchScore": 0,
"urn": "string",
"profileId": "string",
"screeningId": 0,
"accountName": "string",
"alertId": 0,
"categories": [
"string"
],
"callReference": "string",
"source": "string"
}
],
"totalAlertCount": 0
}Get Case Alerts For A Case
The section below describes how to call the Get Case Alerts for a Case endpoint.
How to use
To call the endpoint you will need to perform a HTTP GET request to the URL:
| Url | API Version |
|---|---|
| https://api.w2globaldata.com/cases/{caseId}/alerts | 2.8+ |
Example Response
The following will be returned if the request was successful.
json
[
{
"alertStatus": "string: NewAlert|HighRisk|MediumRisk|LowRisk|FalsePositive",
"serviceName": "string",
"caseId": "string",
"caseName": "string",
"caseDayOfBirth": 0,
"caseMonthOfBirth": 0,
"caseYearOfBirth": 0,
"matchedName": "string",
"matchedDayOfBirth": 0,
"matchedMonthOfBirth": 0,
"matchedYearOfBirth": 0,
"dateCreated": "2024-09-12T14:49:23.335Z",
"dateLastUpdated": "2024-09-12T14:49:23.335Z",
"dobMatchScore": 0,
"nameMatchScore": 0,
"urn": "string",
"profileId": "string",
"screeningId": 0,
"accountName": "string",
"alertId": 0,
"categories": [
"string"
],
"callReference": "string",
"source": "string"
}
]Remediate a Case Alert
The section below describes how to call the Remediate a Case Alert endpoint.
How to use
To call the endpoint you will need to perform a HTTP POST request to the URL:
| Url | API Version |
|---|---|
| https://api.w2globaldata.com/cases/{caseId}/alert/{alertId}/remediate | 2.8+ |
Example Request
json
{
"message": "string",
"alertStatus": "string: NewAlert|HighRisk|MediumRisk|LowRisk|FalsePositive"
}| Property Name | Type | Optional/Mandatory | Notes |
|---|---|---|---|
| Message | String | Optional | A comment relating to the remediation event. Maximum of 255 characters. |
| AlertStatus | String | Mandatory | The new alert status of the alert. Can be one of the following:NewAlertHighRiskMediumRiskLowRiskFalsePositive |
Example Response
If the request was successful, a 200 OK status code will be returned.
Remediate Multiple Case Alerts
The section below describes how to call the Remediate Multiple Case Alerts endpoint.
How to use
To call the endpoint you will need to perform a HTTP POST request to the URL:
| Url | API Version |
|---|---|
| https://api.w2globaldata.com/cases/{caseId}/alerts/remediate | 2.8+ |
Example Request
json
{
"message": "string",
"remediateAlertRequests": [
{
"alertId": 0,
"message": "string",
"alertStatus": "string: NewAlert|HighRisk|MediumRisk|LowRisk|FalsePositive"
}
]
}| Property Name | Type | Optional/Mandatory | Notes |
|---|---|---|---|
| Message | String | Optional | A comment relating to the remediation event. Maximum of 255 characters. If no message is set for an instance of RemediateAlertRequest this message will be used. |
| RemediateAlertRequests | Array of RemediateAlertRequest | Optional | An Array of RemediateAlertRequest objects. |
RemediateAlertRequest
| Property Name | Type | Optional/Mandatory | Notes |
|---|---|---|---|
| AlertId | Integer | Mandatory | The id of the alert to be remediated. |
| Message | String | Optional | A comment relating to the remediation event. Maximum of 255 characters. If set, this message will take prescedence over the top level Message. |
| AlertStatus | String | Mandatory | The new alert status of the alert. Can be one of the following:NewAlertHighRiskMediumRiskLowRiskFalsePositive |
Example Response
If the request was successful, a 200 OK status code will be returned.