Skip to main content
WEBHOOK
amlMonitoring
{
  "monitoringId": "<string>",
  "name": "<string>",
  "surname": "<string>",
  "nationality": "<string>",
  "dob": "<string>",
  "isActive": true,
  "expiration": "<string>",
  "scanRefList": [
    "<string>"
  ],
  "alertStatus": "ALERT",
  "status": "ACTIVE",
  "pepsStatus": "NOT_CHECKED",
  "sanctionsStatus": "NOT_CHECKED",
  "adverseMediaStatus": "NOT_CHECKED",
  "results": [
    {
      "status": {
        "serviceSuspected": true,
        "serviceUsed": true,
        "serviceFound": true,
        "checkSuccessful": true,
        "overallStatus": "SUSPECTED"
      },
      "serviceName": "<string>",
      "serviceGroupType": "<string>",
      "uid": "<string>",
      "errorMessage": "<string>",
      "data": [
        {
          "name": "<string>",
          "surname": "<string>",
          "nationality": "<string>",
          "dob": "<string>",
          "suspicion": "SANCTION",
          "reason": "<string>",
          "listNumber": "<string>",
          "listName": "<string>",
          "score": 123,
          "lastUpdate": "<string>",
          "exitDate": "<string>",
          "isPerson": true,
          "isActive": true,
          "linkedDocument": "<string>",
          "pepLevel": 123,
          "category": "<string>",
          "otherInformation": "<string>",
          "checkDate": "<string>",
          "whitelisted": true
        }
      ]
    }
  ],
  "amlCheck": {
    "overallStatus": "NOT_CHECKED",
    "statusSetAt": "2023-11-07T05:31:56Z",
    "adverseMedia": [
      {
        "title": "<string>",
        "url": "<string>",
        "text": "<string>",
        "score": "<string>",
        "type": "<string>",
        "publishDate": "<string>",
        "status": "<string>"
      }
    ],
    "amlCheck": [
      {
        "resourceId": "<string>",
        "score": 123,
        "match": "<string>",
        "name": "<string>",
        "addresses": [
          {
            "geography": "<string>",
            "city": "<string>"
          }
        ],
        "nationalities": [
          "AF"
        ],
        "datesOfBirth": [
          "<string>"
        ],
        "datasets": [
          "PEP_CURRENT"
        ],
        "currentSanBodyIds": [
          123
        ],
        "formerSanBodyIds": [
          123
        ],
        "version": 123,
        "gender": "MALE",
        "profileImage": "<string>",
        "pepTier": "PEP_TIER_1"
      }
    ]
  }
}

Headers

Idenfy-Event-Type
enum<string>
required
Available options:
AML_MONITORING
Idenfy-Signature
string

Webhook signature

Body

application/json
monitoringId
string
required
name
string
required
surname
string
required
nationality
string
required
dob
string | null
required
isActive
boolean
required
expiration
string | null
required
scanRefList
string[]
required
alertStatus
enum<string>
required
deprecated

AML monitoring v2 status

Available options:
ALERT,
DECLINED,
ACCEPTED,
PENDING,
STATUS
status
enum<string>
required

AML monitoring v3 status

Available options:
ACTIVE,
STOPPED,
PENDING,
ALERT
pepsStatus
enum<string>
required
Available options:
NOT_CHECKED,
NO_FLAGS,
FALSE_POSITIVE,
TRUE_POSITIVE,
FLAGS_FOUND
sanctionsStatus
enum<string>
required
Available options:
NOT_CHECKED,
NO_FLAGS,
FALSE_POSITIVE,
TRUE_POSITIVE,
FLAGS_FOUND
adverseMediaStatus
enum<string>
required
Available options:
NOT_CHECKED,
NO_FLAGS,
FALSE_POSITIVE,
TRUE_POSITIVE,
FLAGS_FOUND
results
object[]
required
amlCheck
object
required

Response

200

Return a 200 status to indicate that the data was received successfully.