API Reference
API ReferenceChangelogFAQDashboard

Get AML case data

get https://api.sumsub.com/resources/api/applicants//amlCase

Overview

Use this method to retrieve the most recent active AML Case for a specific applicant. To update the AML hit review results, refer to the following method.

🚧

Attention

The rate limit for this endpoint is 10 requests per minute.

Request example

curl -X GET \
     'https://api.sumsub.com/resources/api/applicants/632acad6f170310001c0e054/amlCase'

Response explained

The response is a JSON file that represents the AML Case with augmented and structured information.

📘

Note

Some fields may be omitted or return a null value, depending on the availability of the data.

Root variables

FieldTypeDescription
idStringUnique identifier of the AML case.
createdAtStringDate and time (UTC) the AML Case was created in the system (format YYYY-MM-DD HH:MM:SS, e.g., 2025-04-03 11:35:16).
targetEntityTypeStringSpecifies the type of entity being screened. (always applicant).
targetEntityIdStringUnique identifier of the applicant in the Sumsub system.
screeningVendorStringName of the vendor used to perform the screening in the camelCase format, e.g., complyAdvantage.
ongoingMonitoringObjectIncludes information regarding the Ongoing AML monitoring state.
reviewObjectIncludes the answer to the AML check.
riskLabelsArray of stringsList of assigned AML risk labels.
hitsArray of objectsEach object represents a found match or potential match found during screening processes.

ⓘ Note that the id (hitId) attribute is required to update AML Hit review.

ongoingMonitoring

FieldTypeDescription
enabledBooleanIndicates if the Ongoing AML monitoring is enabled for this AML case (true), or not (false).

review

FieldTypeDescription
answerStringCheck answer:
  • RED — the check returned a high risk indication.
  • YELLOW — the request did not contain sufficient data to return a conclusive decision.
  • GREEN — the check ended up successfully.

hits

FieldTypeDescription
idStringUnique identifier of the hit.
nameStringApplicant name that has been screened.
entityTypeStringApplicant entity type. Only the following types are available:
  • individual — if the applicant is a natural person.
  • company — if the applicant is a legal entity.
birthDatesList of stringsList of dates (only if YYYY-MM-DD format is available). the field may be omitted if there are no such dates.
birthYearsList of stringsList of years from the birthDates in either full date or year-only YYYY format.
monitoringUpdatedAtDateDate and time (UTC) the ongoing monitoring result was last updated (format YYYY-MM-DD HH:MM:SS, e.g., 2025-04-03 11:35:16).
sourcesArray of objectsConcatenation of mapped versions of sourceNotes, mediaEntries and relatedUrls.
reviewObjectDetails of the AML hit review result.
riskLabelsArray of stringsList of assigned AML risk labels .

sources

FieldTypeDescription
typeStringType of information source (watchlist, media, related).
urlStringURL of the source.
nameStringName of the source, if applicable.
startDateDateDate and time (UTC) from which the applicant was included in the watchlist (format YYYY-MM-DD HH:MM:SS, e.g., 2020-04-03 11:35:16).
endDateDateDate and time (UTC) from which the applicant was excluded from the watchlist (format YYYY-MM-DD HH:MM:SS, e.g., 2025-04-03 11:35:16).
publishedDateDateDate and time (UTC) the article was published in the media source (format YYYY-MM-DD HH:MM:SS, e.g., 2025-04-03 11:35:16).
titleStringTitle of the article in the media, if available.
annotationStringAnnotation to the article in the media.

hits.review

FieldTypeDescription
matchStatusStringMatch status: unknown, potential_match, false_positive, true_positive. See this article for more information.
whitelistedBoolean

Specifies whether the AML hit is whitelisted:

  • true — whitelisted hit.
  • false — the hit is not in a whitelist and can be blocklisted.
modifiedAtDateDate and time (UTC) the hit review status was last updated (format YYYY-MM-DD HH:MM:SS, e.g., 2025-04-03 11:35:16).

Response examples

If the request is successfully sent and processed, you will get a response like the one below.

{
  "id": "67ee727396ecd60b9d001461",
  "createdAt": "2025-04-03 11:35:16",
  "targetEntityType": "applicant",
  "targetEntityId": "67ee726a96ecd60b9d001439",
  "screeningVendor": "complyAdvantage",
  "ongoingMonitoring": {
    "enabled": false // flag only, i.e. no dates etc.
  },
  "review": {
    "answer": "GREEN"
  },
  "riskLabels": [
    "crime",
    "adverseMedia",
    "terrorism",
    "fitnessProbity",
    "pep"
  ],
  "hits": [
    // Hit #1: Non-ongoing, warning (criminal) hit.
    {
      "id": "8BX9MTAENC6WJOI",
      "name": "John Doe",
      "entityType": "individual",
      "birthDates": [
        "1961-09-16" // birthDates only if YYYY-MM-DD format is available.
      ],
      "birthYears": [
        "1961"
      ],
      "sources": [
        {
          "type": "watchlist",
          "name": "United States New York Department of Corrections Most Wanted",
          "url": "https://doccs.ny.gov/osi-most-wanted",
          "startDate": "2019-09-11 00:00:00",
          "endDate": "2020-06-03 00:00:00"
        },
        {
          "type": "related",
          "url": "http://161.11.133.89/mostwanted/mostwanteddet.asp?..."
        }
      ],
      "review": {
        "matchStatus": "false_positive",
        "whitelisted": false,
        "modifiedAt": "2025-04-03 11:35:27"
      },
      "riskLabels": [
        "crime"
      ]
    },
    // Hit #2, from ongoing monitoring, adverse media.    
    {
      "id": "JRT7ZR7HT4WJAC8",
      "name": "John Doe",
      "entityType": "individual",
      "birthYears": [
        "1981",
        "1984"
      ],
      "monitoringUpdatedAt": "2025-04-12 03:17:42",
      "sources": [
        {
          "type": "watchlist",
          "name": "ComplyAdvantage Adverse Media"
        },
        {
          "type": "watchlist",
          "name": "United States Pennsylvania Most Wanted Absconders",
          "url": "https://www.pa.gov/cor/absconders/Search",
          "startDate": "2022-11-13 00:00:00"
        },
        {
          "type": "media",
          "url": "http://www.themalaymailonline.com/features/article/fbi-data-shows-lgbt-community-most-likely-target-of-hate-crimes",
          "publishedDate": "2016-11-06 00:00:00",
          "title": "(no title)",
          "annotation": "Palm Springs officials said they believed it was the second crime there that year that targeted LGBT people. In March, Elliot Morales was convicted of murder as a hate crime for killing Mark Carson, a gay black man, in Manhattan three years earlier. Morales had shouted anti-gay slurs at Carson and his companion before shooting him."
        },
        {
          "type": "media",
          "url": "http://www.nydailynews.com/new-york/accused-killer-shot-unarmed-gay-man-thinks-innocent-article-1.2550925",
          "publishedDate": "2016-03-02 00:00:00",
          "title": "(no title)",
          "annotation": "Accused killer who shot gay man considers himself trisexual - NY Daily News"
        },
        {
          "type": "related",
          "url": "https://www.pa.gov/cor/absconders/Absconder/9284W"
        }
      ],
      "review": {
        "matchStatus": "false_positive",
        "whitelisted": false,
        "modifiedAt": "2025-04-03 11:35:27"
      },
      "riskLabels": [
        "crime",
        "adverseMedia"
      ]
    }
  ]
}

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:

{
  "code": 404,
  "correlationId": "43251cefe02b3ea2484df0a10e364a12",
  "errorCode": 0,
  "description": "HTTP 404 Not Found"
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!