Update alert

PATCH 
/alerts/:id

Update an alert by its ID.

Request

Path Parameters

id uuidrequired

application/json

Body

required

severity string

Possible values: [Low, Medium, High]

category string

Possible values: [Onboarding, Ongoing monitoring]

type string

Possible values: [AML Screening, IP Screening, Email Screening, KYC Drop-off, Onchain Monitoring, Fraud, Transaction Monitoring, Duplicate]

status string

Possible values: [Open, Under Investigation, Pending, Closed, Escalated]

name string
description stringnullable
assignedTo stringnullable
seen boolean
reason stringnullable

Responses

200

Successful response

application/json

Schema

Schema

id uuidrequired
severity stringrequired

Possible values: [Low, Medium, High]

category stringrequired

Possible values: [Onboarding, Ongoing monitoring]

type stringrequired

Possible values: [AML Screening, IP Screening, Email Screening, KYC Drop-off, Onchain Monitoring, Fraud, Transaction Monitoring, Duplicate]

status stringrequired

Possible values: [Open, Under Investigation, Pending, Closed, Escalated]

name stringrequired
description stringnullablerequired
assignedTo stringnullablerequired
seen booleanrequired
customerId uuidrequired
cmsProjectId stringrequired
createdAt date-timerequired
updatedAt date-timerequired
createdBy stringrequired
updatedBy stringrequired
reason stringnullablerequired
notes object[]
Array [
id uuidrequired
name stringrequired
description stringnullablerequired
data nullable
cmsProjectId stringrequired
createdAt date-timerequired
updatedAt date-timerequired
createdBy stringrequired
updatedBy stringrequired
documents object[]
Array [
id uuidrequired
objectKey uuidrequired
filename stringrequired
mimetype stringrequired
description stringnullablerequired
cmsProjectId stringrequired
createdAt date-timerequired
createdBy stringrequired
presignedUrl stringrequired
]
]
complyAdvantageData objectnullable
id uuidrequired
customerId uuidrequired
searchId numbernullablerequired
searchRef stringnullablerequired
searchResult objectrequired
client_ref stringrequired
id numberrequired
ref stringrequired
searcher_id numberrequired
assignee_id numberrequired
filters object
types string[]nullable
Possible values: [sanction, warning, fitness-probity, pep, pep-class-1, pep-class-2, pep-class-3, pep-class-4, adverse-media, adverse-media-financial-crime, adverse-media-violent-crime, adverse-media-sexual-crime, adverse-media-terrorism, adverse-media-fraud, adverse-media-narcotics, adverse-media-general, adverse-media-v2-property, adverse-media-v2-financial-aml-cft, adverse-media-v2-fraud-linked, adverse-media-v2-narcotics-aml-cft, adverse-media-v2-violence-aml-cft, adverse-media-v2-terrorism, adverse-media-v2-cybercrime, adverse-media-v2-general-aml-cft, adverse-media-v2-regulatory, adverse-media-v2-financial-difficulty, adverse-media-v2-violence-non-aml-cft, adverse-media-v2-other-financial, adverse-media-v2-other-serious, adverse-media-v2-other-minor]
birth_year numbernullable
remove_deceased numbernullable
Possible values: <= 1
entity_type stringnullable
Possible values: [person, company, organisation, vessel, aircraft]
country_codes string[]nullable
Possible values: [AN, XK, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VI, WF, EH, YE, ZM, ZW]
match_status stringrequired
Possible values: [unknown, no_match, potential_match, false_positive, true_positive, true_positive_approve, true_positive_reject]
risk_level stringrequired
Possible values: [low, medium, high, unknown]
search_term stringrequired
submitted_term stringrequired
total_hits numberrequired
total_matches numberrequired
total_blacklist_hits numberrequired
created_at date-timerequired
updated_at date-timerequired
tags object[]
labels undefined[]required
limit numberrequired
offset numberrequired
searcher object
id numberrequired
email emailrequired
name stringrequired
phone stringrequired
created_at date-timerequired
user_is_active booleanrequired
assignee object
id numberrequired
email emailrequired
name stringrequired
phone stringrequired
created_at date-timerequired
user_is_active booleanrequired
hits object[]
Array [
doc objectrequired
id stringrequired
last_updated_utc date-timerequired
created_utc date-timerequired
fields object[]
Array [
name stringrequired
source string
value stringrequired
locale string
tag string
]
types string[]required
Possible values: [sanction, warning, fitness-probity, pep, pep-class-1, pep-class-2, pep-class-3, pep-class-4, adverse-media, adverse-media-financial-crime, adverse-media-violent-crime, adverse-media-sexual-crime, adverse-media-terrorism, adverse-media-fraud, adverse-media-narcotics, adverse-media-general, adverse-media-v2-property, adverse-media-v2-financial-aml-cft, adverse-media-v2-fraud-linked, adverse-media-v2-narcotics-aml-cft, adverse-media-v2-violence-aml-cft, adverse-media-v2-terrorism, adverse-media-v2-cybercrime, adverse-media-v2-general-aml-cft, adverse-media-v2-regulatory, adverse-media-v2-financial-difficulty, adverse-media-v2-violence-non-aml-cft, adverse-media-v2-other-financial, adverse-media-v2-other-serious, adverse-media-v2-other-minor]
name stringrequired
entity_type stringrequired
Possible values: [person, company, organisation, vessel, aircraft]
aka object[]required
Array [
name stringrequired
]
associates object[]
Array [
association stringrequired
name stringrequired
]
sources string[]required
keywords undefined[]required
media object[]
Array [
date date-time
snippet stringrequired
title stringrequired
url urirequired
]
source_notes
match_types string[]required
match_types_details object[]required
Array [
aml_types string[]required
matching_name stringrequired
name_matches object[]required
Array [
match_types string[]required
query_term stringrequired
]
secondary_matches undefined[]required
sources string[]required
]
match_status stringrequired
is_whitelisted booleanrequired
score numberrequired
]
blacklist_hits undefined[]
searchEntities object[]nullable
Array [
id stringrequired
last_updated_utc date-timerequired
created_utc date-timerequired
key_information objectnullable
name stringrequired
entity_type stringrequired
Possible values: [person, company, organisation, vessel, aircraft]
types string[]nullable
Possible values: [sanction, warning, fitness-probity, pep, pep-class-1, pep-class-2, pep-class-3, pep-class-4, adverse-media, adverse-media-financial-crime, adverse-media-violent-crime, adverse-media-sexual-crime, adverse-media-terrorism, adverse-media-fraud, adverse-media-narcotics, adverse-media-general, adverse-media-v2-property, adverse-media-v2-financial-aml-cft, adverse-media-v2-fraud-linked, adverse-media-v2-narcotics-aml-cft, adverse-media-v2-violence-aml-cft, adverse-media-v2-terrorism, adverse-media-v2-cybercrime, adverse-media-v2-general-aml-cft, adverse-media-v2-regulatory, adverse-media-v2-financial-difficulty, adverse-media-v2-violence-non-aml-cft, adverse-media-v2-other-financial, adverse-media-v2-other-serious, adverse-media-v2-other-minor]
grouped_types object[]nullable
Array [
type stringrequired
Possible values: [sanction, warning, fitness-probity, pep, pep-class-1, pep-class-2, pep-class-3, pep-class-4, adverse-media, adverse-media-financial-crime, adverse-media-violent-crime, adverse-media-sexual-crime, adverse-media-terrorism, adverse-media-fraud, adverse-media-narcotics, adverse-media-general, adverse-media-v2-property, adverse-media-v2-financial-aml-cft, adverse-media-v2-fraud-linked, adverse-media-v2-narcotics-aml-cft, adverse-media-v2-violence-aml-cft, adverse-media-v2-terrorism, adverse-media-v2-cybercrime, adverse-media-v2-general-aml-cft, adverse-media-v2-regulatory, adverse-media-v2-financial-difficulty, adverse-media-v2-violence-non-aml-cft, adverse-media-v2-other-financial, adverse-media-v2-other-serious, adverse-media-v2-other-minor]
]
match_types string[]nullable
sources string[]nullable
source_notes nullable
aka object[]nullable
Array [
name stringrequired
]
date_of_birth stringnullable
dates_of_birth string[]nullable
match_status stringnullable
Possible values: [unknown, no_match, potential_match, false_positive, true_positive, true_positive_approve, true_positive_reject]
risk_level stringnullable
Possible values: [low, medium, high, unknown]
is_whitelisted booleannullable
age numbernullable
death_age nullable
date_of_death nullable
primary_country nullable
country_names stringnullable
designation stringnullable
associates object[]nullable
Array [
association stringrequired
name stringrequired
]
uncategorized objectnullable
keywords undefined[]nullable
media object[]nullable
Array [
date date-time
snippet stringrequired
title stringrequired
url urirequired
]
assets undefined[]nullable
match_types string[]nullable
related undefined[]nullable
fields undefined[]nullable
full_listing objectnullable
anyOf
navigation objectnullable
next nullable
previous nullable
]
requestData objectrequired
search_term stringrequired
represents name of the entity
client_ref stringrequired
Your reference for this person/entity for which you are searching. Used for tracking searches and auto-whitelisting recurring results
search_profile stringnullable
The Profile ID of a search profile that can be retrieved from the UI
fuzziness numbernullable
Possible values: <= 1
determines how closely the returned results must match the supplied name. Overridden by exact_match
offset numbernullable
match results from the database, starting form the offset value
limit numbernullable
math results from the database, taking up this many matches each search
filters object
specify filters within the search to narrow down the results
types string[]nullable
Possible values: [sanction, warning, fitness-probity, pep, pep-class-1, pep-class-2, pep-class-3, pep-class-4, adverse-media, adverse-media-financial-crime, adverse-media-violent-crime, adverse-media-sexual-crime, adverse-media-terrorism, adverse-media-fraud, adverse-media-narcotics, adverse-media-general, adverse-media-v2-property, adverse-media-v2-financial-aml-cft, adverse-media-v2-fraud-linked, adverse-media-v2-narcotics-aml-cft, adverse-media-v2-violence-aml-cft, adverse-media-v2-terrorism, adverse-media-v2-cybercrime, adverse-media-v2-general-aml-cft, adverse-media-v2-regulatory, adverse-media-v2-financial-difficulty, adverse-media-v2-violence-non-aml-cft, adverse-media-v2-other-financial, adverse-media-v2-other-serious, adverse-media-v2-other-minor]
birth_year numbernullable
remove_deceased numbernullable
Possible values: <= 1
entity_type stringnullable
Possible values: [person, company, organisation, vessel, aircraft]
country_codes string[]nullable
Possible values: [AN, XK, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VI, WF, EH, YE, ZM, ZW]
tags object[]nullable
name => value pairs, to search later using defined tags here
share_url numbernullable
Possible values: <= 1
include a shareable URL to access search publicly
exact_match booleannullable
Exact match disables all standard and optional matching behaviours (Honorifics, affixes, initials, glued name, name variation, equivalent names, extra words in entity,...) 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviours (standard and optional)
executionId stringrequired
alertId uuidnullablerequired
isMonitored booleannullablerequired
createdAt date-timerequired
updatedAt date-timerequired
duplicateData objectnullable
original objectrequired
customerId uuidrequired
customerInfo stringnullable
profilePicture stringnullable
idDocumentUrl stringnullable
duplicate objectrequired
customerId uuidrequired
customerInfo stringnullable
profilePicture stringnullable
idDocumentUrl stringnullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "severity": "Low",
  "category": "Onboarding",
  "type": "AML Screening",
  "status": "Open",
  "name": "string",
  "description": "string",
  "assignedTo": "string",
  "seen": true,
  "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cmsProjectId": "string",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "createdBy": "string",
  "updatedBy": "string",
  "reason": "string",
  "notes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "cmsProjectId": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "createdBy": "string",
      "updatedBy": "string",
      "documents": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "objectKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "filename": "string",
          "mimetype": "string",
          "description": "string",
          "cmsProjectId": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "createdBy": "string",
          "presignedUrl": "string"
        }
      ]
    }
  ],
  "complyAdvantageData": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "searchId": 0,
    "searchRef": "string",
    "searchResult": {
      "client_ref": "string",
      "id": 0,
      "ref": "string",
      "searcher_id": 0,
      "assignee_id": 0,
      "filters": {
        "types": [
          "sanction"
        ],
        "birth_year": 0,
        "remove_deceased": 0,
        "entity_type": "person",
        "country_codes": [
          "AN"
        ]
      },
      "match_status": "unknown",
      "risk_level": "low",
      "search_term": "string",
      "submitted_term": "string",
      "total_hits": 0,
      "total_matches": 0,
      "total_blacklist_hits": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "tags": [
        {}
      ],
      "labels": [
        null
      ],
      "limit": 0,
      "offset": 0,
      "searcher": {
        "id": 0,
        "email": "user@example.com",
        "name": "string",
        "phone": "string",
        "created_at": "2024-07-29T15:51:28.071Z",
        "user_is_active": true
      },
      "assignee": {
        "id": 0,
        "email": "user@example.com",
        "name": "string",
        "phone": "string",
        "created_at": "2024-07-29T15:51:28.071Z",
        "user_is_active": true
      },
      "hits": [
        {
          "doc": {
            "id": "string",
            "last_updated_utc": "2024-07-29T15:51:28.071Z",
            "created_utc": "2024-07-29T15:51:28.071Z",
            "fields": [
              {
                "name": "string",
                "source": "string",
                "value": "string",
                "locale": "string",
                "tag": "string"
              }
            ],
            "types": [
              "sanction"
            ],
            "name": "string",
            "entity_type": "person",
            "aka": [
              {
                "name": "string"
              }
            ],
            "associates": [
              {
                "association": "string",
                "name": "string"
              }
            ],
            "sources": [
              "string"
            ],
            "keywords": [
              null
            ],
            "media": [
              {
                "date": "2024-07-29T15:51:28.071Z",
                "snippet": "string",
                "title": "string",
                "url": "string"
              }
            ],
            "source_notes": {}
          },
          "match_types": [
            "string"
          ],
          "match_types_details": [
            {
              "aml_types": [
                "string"
              ],
              "matching_name": "string",
              "name_matches": [
                {
                  "match_types": [
                    "string"
                  ],
                  "query_term": "string"
                }
              ],
              "secondary_matches": [
                null
              ],
              "sources": [
                "string"
              ]
            }
          ],
          "match_status": "string",
          "is_whitelisted": true,
          "score": 0
        }
      ],
      "blacklist_hits": [
        null
      ]
    },
    "searchEntities": [
      {
        "id": "string",
        "last_updated_utc": "2024-07-29T15:51:28.071Z",
        "created_utc": "2024-07-29T15:51:28.071Z",
        "key_information": {
          "name": "string",
          "entity_type": "person",
          "types": [
            "sanction"
          ],
          "grouped_types": [
            {
              "type": "sanction"
            }
          ],
          "match_types": [
            "string"
          ],
          "sources": [
            "string"
          ],
          "aka": [
            {
              "name": "string"
            }
          ],
          "date_of_birth": "string",
          "dates_of_birth": [
            "string"
          ],
          "match_status": "unknown",
          "risk_level": "low",
          "is_whitelisted": true,
          "age": 0,
          "country_names": "string",
          "designation": "string",
          "associates": [
            {
              "association": "string",
              "name": "string"
            }
          ]
        },
        "uncategorized": {
          "keywords": [
            null
          ],
          "media": [
            {
              "date": "2024-07-29T15:51:28.071Z",
              "snippet": "string",
              "title": "string",
              "url": "string"
            }
          ],
          "assets": [
            null
          ],
          "match_types": [
            "string"
          ],
          "related": [
            null
          ],
          "fields": [
            null
          ]
        },
        "full_listing": {},
        "navigation": {}
      }
    ],
    "requestData": {
      "search_term": "string",
      "client_ref": "string",
      "search_profile": "string",
      "fuzziness": 0,
      "offset": 0,
      "limit": 0,
      "filters": {
        "types": [
          "sanction"
        ],
        "birth_year": 0,
        "remove_deceased": 0,
        "entity_type": "person",
        "country_codes": [
          "AN"
        ]
      },
      "tags": [
        {}
      ],
      "share_url": 0,
      "exact_match": true
    },
    "executionId": "string",
    "alertId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isMonitored": true,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  },
  "duplicateData": {
    "original": {
      "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerInfo": "string",
      "profilePicture": "string",
      "idDocumentUrl": "string"
    },
    "duplicate": {
      "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerInfo": "string",
      "profilePicture": "string",
      "idDocumentUrl": "string"
    }
  }
}

default

Error response

application/json

Schema

Schema

message stringrequired
code stringrequired
issues object[]
Array [
message stringrequired
]

Example (from schema)

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Loading...