Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Alerts & Risks

Create an alert mute

Creates an alert mute for the current client account. CUSTOMER entity identifiers must be valid UUIDs; COUNTERPARTY identifiers are accepted as strings.

You need the "Create and delete mutes" permission to use this endpoint.

post/v3/alerts/mutes

Request body

risk_codestring required

Risk code/profile identifier to mute for the entity.

risk_signal_identifierstring uuid nullable

Optional risk signal identifier associated with the alert mute.

source_risk_app'UNSPECIFIED' | 'CUSTOMER_SCREENING' | 'PAYMENT_SCREENING' required

Risk application that produced the muted risk.

Example request

{
  "entity": {
    "identifier": "89013cff-8b3a-4301-bb59-c20f1d381c20",
    "type": "CUSTOMER"
  },
  "risk_code": "PEP",
  "risk_signal_identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "source_risk_app": "PAYMENT_SCREENING"
}

Response

Alert mute successfully created

created_atstring date-time required

Timestamp when the alert mute was created.

created_bystring nullable

Identifier of the user that created the alert mute.

identifierstring uuid required

Unique identifier of the alert mute.

risk_codestring required

Risk code/profile identifier muted for the entity.

risk_signal_identifierstring uuid nullable

Risk signal identifier associated with the alert mute, when provided.

Example response

{
  "created_at": "2026-03-10T14:55:17.835Z",
  "created_by": "019cd83e-c008-71ca-b7d8-4b834b516614",
  "entity": {
    "identifier": "89013cff-8b3a-4301-bb59-c20f1d381c20",
    "type": "CUSTOMER"
  },
  "identifier": "1cf055ed-f05d-4814-902f-654668b12910",
  "risk_code": "PEP",
  "risk_signal_identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}