'
```
# 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
| Field | Type | Description |
| :------------------ | :---------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | String | Unique identifier of the AML case. |
| `createdAt` | String | Date and time (UTC) the AML Case was created in the system (format `YYYY-MM-DD HH:MM:SS`, for example, `2025-04-03 11:35:16`). |
| `targetEntityType` | String | Specifies the type of entity being screened. (always `applicant`). |
| `targetEntityId` | String | Unique identifier of the applicant in the Sumsub system. |
| `vendorAttribution` | String | Indicates a third-party vendor involved in data processing or verification. For example, `Powered by ComplyAdvantage CSOM`. |
| `ongoingMonitoring` | [Object](#ongoingmonitoring-attributes) | Includes information regarding the [Ongoing AML monitoring](https://docs.sumsub.com/sumsub/docs/ongoing-aml-monitoring) state. |
| `review` | [Object](#review-attributes) | Includes the `answer` to the AML check. |
| `riskLabels` | Array of strings | List of assigned [AML risk labels](https://docs.sumsub.com/sumsub/docs/applicant-risk-labels#aml-risk-labels). |
| `hits` | [Array of objects](#hits-element-fields) | Each 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](https://docs.sumsub.com/sumsub/reference/update-aml-hit-review). |
| `quantifindInfo` | [Object](#quantifindinfo-attributes-case-level) | Additional case-level information provided by Quantifind. Returned only for cases screened with Quantifind. |
## `ongoingMonitoring` attributes
| Field | Type | Description |
| :-------- | :------ | :----------------------------------------------------------------------------------------------- |
| `enabled` | Boolean | Indicates if the Ongoing AML monitoring is enabled for this AML case (`true`), or not (`false`). |
## `review` attributes
| Field | Type | Description |
| :------------- | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `reviewAnswer` | String | Check 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` element fields
| Field | Type | Description |
| :-------------------- | :------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | String | Unique identifier of the hit. |
| `name` | String | Applicant name that has been screened. |
| `entityType` | String | Applicant entity type. Only the following types are available:individual — if the applicant is a natural person.company — if the applicant is a legal entity.
|
| `birthDates` | List of strings | List of dates (only if `YYYY-MM-DD` format is available). the field may be omitted if there are no such dates. |
| `birthYears` | List of strings | List of years from the `birthDates` in either full date or year-only `YYYY` format. |
| `monitoringUpdatedAt` | Date | Date and time (UTC) the ongoing monitoring result was last updated (format `YYYY-MM-DD HH:MM:SS`, for example, `2025-04-03 11:35:16`). |
| `sources` | [Array of objects](#sources-elemet-fields) | Concatenation of mapped versions of `sourceNotes`, `mediaEntries` and `relatedUrls`. |
| `review` | [Object](#hitsreview-attributes) | Details of the AML hit review result. |
| `riskLabels` | Array of strings | List of assigned [AML risk labels](https://docs.sumsub.com/sumsub/docs/applicant-risk-labels#aml-risk-labels) . |
| `quantifindInfo` | [Object](#hitsquantifindinfo-attributes-hit-level) | Additional hit-level information provided by Quantifind. Returned only for hits screened with Quantifind. |
## `sources` element fields
| Field | Type | Description |
| :-------------- | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | String | Type of information source (`watchlist`, `media`, `related`). |
| `url` | String | URL of the source. |
| `name` | String | Name of the source, if applicable. |
| `startDate` | Date | Date and time (UTC) from which the applicant was included in the watchlist (format `YYYY-MM-DD HH:MM:SS`, for example, `2020-04-03 11:35:16`). |
| `endDate` | Date | Date and time (UTC) from which the applicant was excluded from the watchlist (format `YYYY-MM-DD HH:MM:SS`, for example, `2025-04-03 11:35:16`). |
| `publishedDate` | Date | Date and time (UTC) the article was published in the media source (format `YYYY-MM-DD HH:MM:SS`, for example, `2025-04-03 11:35:16`). |
| `title` | String | Title of the article in the media, if available. |
| `annotation` | String | Annotation to the article in the media. |
## `hits.review` attributes
| Field | Type | Description |
| :------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `matchStatus` | String | Match status: `unknown`, `potential_match`, `false_positive`, `true_positive`. See [this article](https://docs.sumsub.com/sumsub/docs/aml-how-it-works#watchlist-screening) for more information. |
| `whitelisted` | Boolean | Specifies whether the AML hit is whitelisted:
true — whitelisted hit.false — the hit is not in a whitelist and can be blocklisted.
|
| `modifiedAt` | Date | Date and time (UTC) the hit review status was last updated (format `YYYY-MM-DD HH:MM:SS`, for example, `2025-04-03 11:35:16`). |
| `reviewerName` | String | Name of the reviewer who last updated the hit review status. Visible only to authorized users with [permission](https://docs.sumsub.com/sumsub/docs/user-roles#permissions) to view
personal data. |
## `quantifindInfo` attributes (case level)
Additional information returned by Quantifind for the entire search request. Present only for cases screened with Quantifind.
| Field | Type | Description |
| ------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `warnings` | Array of strings | List of warnings returned by Quantifind for the search request, for example when results were truncated or a request parameter was not recognized. |
| `searchRequestEnrichment` | [Object](#quantifindinfosearchrequestenrichment-attributes) | Information derived by Quantifind from the search request itself, such as the linguistic group and name rarity. |
| `segmentId` | String | Identifier of the Quantifind search segment that can be used to reference the search. |
## `quantifindInfo.searchRequestEnrichment` attributes
Information derived by Quantifind from the search request itself, such as the linguistic group and name rarity.
| Field | Type | Description |
| ----------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `linguisticGroup` | String | Linguistic group detected for the screened name (for example, `Latin`, `Cyrillic`, or `Arabic`). |
| `nameRarity` | [Array of objects](#quantifindinfosearchrequestenrichmentnamerarity-element-fields) | Assessment of the rarity of the screened name, broken down by country. |
## `quantifindInfo.searchRequestEnrichment.nameRarity` element fields
Information about the rarity of the screened name by country.
| Field | Type | Description |
| ------------------- | ------ | ----------------------------------------------------------- |
| `country` | String | Country to which the rarity assessment applies. |
| `rarity` | String | Rarity level of the screened name in the specified country. |
| `rarityDescription` | String | Human-readable description of the name's rarity. |
## `hits.quantifindInfo` attributes (hit level)
Additional information returned by Quantifind for an individual hit. Present only for hits screened with Quantifind.
| Field | Type | Description |
| ----------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `dataSource` | [Object](#hitsquantifindinfodatasource-attributes) | Information about the source that produced the hit. |
| `riskLevel` | String | Overall risk level assigned to the hit by Quantifind. |
| `riskFactors` | [Array of objects](#hitsquantifindinforiskfactors-element-fields) | Risk factors that contributed to the overall risk level. |
| `evidence` | String | Explanation of why Quantifind considered the hit a match. |
| `confidenceLevel` | String | Confidence level of the match, as reported by Quantifind. |
| `nameMatchScore` | Number | Score indicating how closely the matched name corresponds to the screened name. |
| `title` | String | Title of the primary source supporting the hit. |
| `sourceDetail` | String | Additional details about the source, such as the publisher. |
| `datePublished` | String | Publication date of the primary source, as provided by Quantifind. |
| `url` | String | URL of the primary source. |
| `attributes` | [Array of objects](#hitsquantifindinfoattributes-element-fields) | Additional attributes describing the hit as key-value pairs. This field is visible only to authorized users with permission to view personal data. |
| `clusteredLinks` | [Array of objects](#hitsquantifindinfoclusteredlinks-element-fields) | Additional sources clustered with the primary source. This field is visible only to authorized users with permission to view personal data. |
## `hits.quantifindInfo.dataSource` attributes
| Field | Type | Description |
| -------------------- | ------ | ------------------------------------------------------------------ |
| `shortName` | String | Short name of the data source. |
| `longName` | String | Full name of the data source. |
| `maxConfidenceLevel` | String | Highest confidence level that can be assigned by this data source. |
## `hits.quantifindInfo.riskFactors` element fields
| Field | Type | Description |
| ----------- | ------ | -------------------------------------------- |
| `riskLevel` | String | Risk level associated with this risk factor. |
| `name` | String | Name of the risk factor. |
## `hits.quantifindInfo.attributes` element fields
| Field | Type | Description |
| ------- | ------ | ----------------------- |
| `name` | String | Name of the attribute. |
| `value` | String | Value of the attribute. |
## `hits.quantifindInfo.clusteredLinks` element fields
| Field | Type | Description |
| --------------- | ------ | -------------------------------------------------------------------- |
| `title` | String | Title of the clustered source. |
| `sourceDetail` | String | Additional detail about the clustered source, such as the publisher. |
| `datePublished` | String | Publication date of the clustered source, as provided by Quantifind. |
| `url` | String | URL of the clustered source. |
# Response examples
If the request is successfully sent and processed, you will get a response like one of those below.
```json Common example
{
"id": "67ee727396ecd60b9d001461",
"createdAt": "2025-04-03 11:35:16",
"targetEntityType": "applicant",
"targetEntityId": "67ee726a96ecd60b9d001439",
"vendorAttribution": "Powered by ComplyAdvantage CSOM",
"ongoingMonitoring": {
"enabled": false // flag only, that is, no dates and so on.
},
"review": {
"reviewAnswer": "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"
]
}
]
}
```
```json Example with the quantifindInfo attribute
{
"id": "67ee727396ecd60b9d001461",
"createdAt": "2025-04-03 11:35:16",
"targetEntityType": "applicant",
"targetEntityId": "67ee726a96ecd60b9d001439",
"vendorAttribution": "Powered by Quantifind",
"ongoingMonitoring": {
"enabled": false
},
"review": {
"reviewAnswer": "RED"
},
"riskLabels": [
"crime",
"adverseMedia"
],
"hits": [
{
"id": "8BX9MTAENC6WJOI",
"name": "John Doe",
"entityType": "individual",
"birthDates": [
"1961-09-16"
],
"birthYears": [
"1961"
],
"monitoringUpdatedAt": "2025-04-04 09:10:00",
"quantifindInfo": {
"dataSource": {
"shortName": "News Archive",
"longName": "Global Adverse Media — News Archive",
"maxConfidenceLevel": "Strong"
},
"riskLevel": "high",
"riskFactors": [
{
"riskLevel": "high",
"name": "Counterfeit"
},
{
"riskLevel": "medium",
"name": "Legal Proceedings"
}
],
"evidence": "country match + very rare name + precise name",
"confidenceLevel": "Strong",
"nameMatchScore": 0.97,
"title": "Authorities investigate counterfeiting ring",
"sourceDetail": "El Periodico — Crime desk",
"datePublished": "2021-11-30",
"url": "https://example.com/news/article",
"attributes": [
{
"name": "Nationality",
"value": "NIC"
}
],
"clusteredLinks": [
{
"title": "Follow-up coverage of the investigation",
"sourceDetail": "Radio La Primerisima",
"datePublished": "2022-01-15",
"url": "https://example.com/news/follow-up"
}
]
},
"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": "true_positive",
"whitelisted": false,
"modifiedAt": "2025-04-03 11:35:27",
"reviewerName": "john.smith@example.com"
},
"riskLabels": [
"crime"
]
}
],
"quantifindInfo": {
"warnings": [
"Some hits were truncated due to result limit"
],
"searchRequestEnrichment": {
"linguisticGroup": "Latin",
"nameRarity": [
{
"country": "US",
"rarity": "veryRare",
"rarityDescription": "Fewer than 10 known carriers in US"
}
]
},
"segmentId": "1"
}
}
```
If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
```json
{
"code": 404,
"correlationId": "43251cefe02b3ea2484df0a10e364a12",
"errorCode": 0,
"description": "HTTP 404 Not Found"
}
```
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "sumsub-api",
"version": "1.0"
},
"servers": [
{
"url": "https://api.sumsub.com"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"name": "X-App-Token",
"in": "header",
"x-default": ""
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/resources/api/applicants/{applicantId}/amlCase": {
"get": {
"summary": "Get AML case data",
"description": "",
"operationId": "get-aml-case-data",
"parameters": [
{
"name": "applicantId",
"in": "path",
"description": "Unique identifier of the applicant in the Sumsub system.
This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant is created on the Sumsub side, and can be found in the [Dashboard](https://cockpit.sumsub.com/checkus/#/applicants/individual?limit=10&page=0).
If the `applicantId` is unknown to you, use the [Get applicant data (externalUserId)](https://docs.sumsub.com/sumsub/reference/get-applicant-data-via-externaluserid) method to fetch it.",
"schema": {
"type": "string"
},
"required": true
}
]
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```