--- updatedAt: 2026-09-11T13:14:21.000Z agentTools: projectIndex: https://docs.sumsub.com/llms.txt --- # Resolution Rule Chain variables Add context to your resolution rule chains. AML [Resolution Rule Chain](https://docs.sumsub.cdoc:resolution-rule-chain-for-aml-screening) variables let you retrieve specific data about the applicants and apply rules based on this data. For example, you may get the information about the alias of the screened entity and assign a specific officer to check it or obtain information about their age and country and decline the applicants based on it. This article lists all variables available for your rule chains. Some of the variables have nested attributes and elements. # Root variables The table below outlines the root variables that are the most essential data fields. | Field | Description | | :--------------- | :------------------------------- | | `applicant` | Information about the applicant. | | `applicantIdDoc` | Applicant ID document type. | | `input` | AML case input information. | | `screening` | AML screening results. | | `match` | AML hit information. | # Input The table below outlines input variables that contain the essential data about the screened entity. | Field | Description | | :--------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `firstName` | Applicant's first name. | | `firstNameEn` | Applicant's transliterated first name. | | `lastName` | Applicant's last name. | | `lastNameEn` | Transliterated applicant's last name. | | `middleName` | Applicant's middle name. | | `middleNameEn` | Applicant's transliterated middle name. | | `fullName` | Applicant's full name. | | `aliasName` | Alias of the screened entity. For French passports, this field contains the value of the `epouse` field. | | `gender` | Applicant's gender. | | `dob` | Applicant's date of birth. | | `country` | Applicant's country in the ISO 3166-1 alpha-3 format. | | `town` | Applicant's town. | | `state` | Applicant's state. | | `companyInfo` | Applicant's company info. | | `countries` | Applicant's countries in the ISO 3166-1 alpha-3 format. | | `entityType` | Applicant entity type. | | `countryOfBirth` | Applicant's country of birth in the ISO 3166-1 alpha-3 format. | | `nationality ` | Applicant's nationality in the ISO 3166-1 alpha-3 format. | | `analysis` | Risk signals based on the input data. | # Screening The table below outlines the variables related to AML screening results. | Field | Description | | :----------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | AML case ID. | | `createdAt` | AML case creation date. | | `targetEntityType` | Target entity type: applicant or transaction participant. | | `vendor` | AML screening provider. | | `hitsCount` | Matches count. | | `riskLabels` | Risk labels collected from all matches in the case. | | `matchStatuses` | Matches match statuses collected from all matches in the case. | | `answer` | The GREEN/YELLOW/RED/ERROR answer of the check. | | `tags` | AML case tags. One AML rule can add a tag to a case, and another rule can use this tag in its condition. Sumsub stores all AML tags in the AML case. | # Match The table below outlines the variables related to the AML screening match results. | Field | Description | | :-------------------- | :---------------------------------------------------------------- | | `name` | Match name. | | `alternativeNames` | Match alternative names. | | `dobs` | DoBs listed in the match. | | `riskLabels` | AML case risk labels. | | `previousReview` | Previous case review dates. | | `complyAdvantage` | ComplyAdvantage-specific match information. | | `complyAdvantageMesh` | ComplyAdvantage-specific mesh information. | | `worldCheckOne` | World Check One-specific match information. | | `quantifind` | Quantifind-specific match information. | | `analysis` | Signals based on match data. | | `sources` | Signals based on match source. | | `countries` | Countries related to this match. | | `gender` | Gender of the matched entity. Null if not available or ambiguous. | # input.companyInfo The table below outlines the variables related to the applicant company. | Field | Description | | :----------------- | :------------------------------------ | | `name` | Applicant's company name. | | `alternativeNames` | Alternative applicant's company name. | # input.analysis The table below outlines the variables related to the applicant’s personal details. | Field | Description | | :----------- | :-------------------------------------------------- | | `parentName` | Parent name extracted from input data. | | `namesCount` | Words or hieroglyphs count in the applicant’s name. | # screening.targetEntityType The table below outlines the variables related to transaction participants. | Field | Description | | :----------------------- | :---------------------------- | | `applicant` | Applicant data. | | `transactionParticipant` | Transaction participant role. | # screening.vendor The table below outlines the variables related to the screening service provider. | Field | Description | | :-------------------- | :--------------------- | | `complyAdvantageCSOM` | Comply Advantage. | | `worldCheckOne` | World Check One. | | `quantifind` | Quantifind Graphyte. | | `complyAdvantageMesh` | Comply Advantage Mesh. | # match.dobs The table below outlines the variables related to applicants' DoBs. | Field | Description | | :-------- | :------------------- | | `hasData` | DoB data is present. | # match.previousReview The table below outlines the variables related to previous reviews of the detected match. | Field | Description | | :------------ | :-------------------------------- | | `matchStatus` | Match status. | | `riskLevel` | Risk level. | | `whitelisted` | Whitelisted status. | | `modifiedAt` | Date of last review modification. | | `note` | Note left by a reviewer. | # match.complyAdvantage The table below outlines the variables related to previous reviews of the detected match. | Field | Description | | :------------- | :---------------------------------------------------------- | | `warningTypes` | Vendor-specific warning type, such as `pep` or `sanctions`. | | `matchTypes` | Match type. | ### Note The same structure applies to `match.complyAdvantageMesh`. # match.worldCheckOne The table below outlines the variables related to previous reviews of the detected match. | Field | Description | | :--------------- | :---------------------------------------------------------- | | `warningTypes` | Vendor-specific warning type, such as `pep` or `sanctions`. | | `resolutionDate` | Hit resolution date. | | `matchStatus` | Match status based on the resolution toolkit. | | `riskLevel` | Risk level based on the resolution toolkit. | # match.quantifind The table below outlines the variables related to previous reviews of the detected match. | Field | Description | | :----------- | :------------------------------------------------------------------------- | | `riskLevel` | Risk level. | | `confidence` | Quantifind-assessed Confidence Level of the match (Strong, Fair, or Weak). | # match.analysis The table below outlines the variables related to previous reviews of the detected match. | Field | Description | | :-------------- | :--------------------------------------------------------------------- | | `parentName` | Applicant's parent name extracted from match data. | | `tinCompatible` | The results of the matching of the applicant’s TIN to the national ID. | | `namesCount` | Words or hieroglyphs count in the applicant’s name. | # match.sources The table below outlines the variables related to previous reviews of the detected match. | Field | Description | | :------------------ | :-------------------------------------------------------------------------------------------------------- | | `earliestStartDate` | Earliest `startDate` value among all sources. Returns `null` if all source `startDate` values are `null`. | | `latestEndDate` | Latest `endDate` value among all sources. Returns `null` if all source `endDate` values are `null`. | | `names` | The name of the database the match comes from. | # match.countries The table below outlines the variables related to previous reviews of the detected match. | Field | Description | | :------------- | :--------------------------------------------------------- | | `all` | Deduplicated union of all country codes across every role. | | `location` | Countries associated with the entity's physical location. | | `placeOfBirth` | Countries associated with the entity's place of birth. | | `placeOfDeath` | Countries associated with the entity's place of death. | | `operatesIn` | Countries in which the entity operates. | | `registeredIn` | Countries in which the entity is registered. | | `vesselFlag` | Flag countries for vessels associated with the entity. | # Functions The table below outlines the variables related to the functions of the selected rules. | Field | Parameters | Description | | :------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | | `namesCompatible` | `match`—the match data used for comparison
`name`—the name used for comparison
`country`—the specified country's normalization rules used for comparison
`comparisonMode`—name comparison mode: strict or weakContainment.
`compareAlternativeNames`—flag indicating if alternative names of the match will be taken into account. | Returns `true `if the match name and the specified name are compatible. | | `namesIncompatible` | `match`—the match name
`name`—the name used for comparison
`country`—the specified country's normalization rules used for comparison
`comparisonMode`—name comparison mode: strict or weakContainment.
`compareAlternativeNames`—flag indicating if alternative names of the match will be taken into account. | Returns `true` if the match name and the specified name are not compatible. | | `dobsCompatible` | `dobs`—the match dates of birth
`date`—the date of birth used for comparison
`comparisonMod`—DoB comparison mode: strict or weakContainment. | Returns `true` if the match dates of birth and the specified date are compatible. | | `dobsIncompatible` | `dobs`—the match dates of birth
`date`—the date used for comparison
`comparisonMod`—DoB comparison mode: strict or weak. | Returns `true`, if the match dates of birth and the specified date are not compatible. | When you add one of these functions in the AML rule condition editor, its arguments are pre-filled with the default values below. However, you can adjust any argument as needed. | Parameter | Default value | | ------------------------- | ----------------- | | `match` | `match` | | `inputName` | `input.fullName` | | `country` | `input.country` | | `comparisonMode` | `weakContainment` | | `compareAlternativeNames` | `true` | Default arguments for `dobsCompatible` and `dobsIncompatible `are the following: | Parameter | Default value | | ---------------- | ------------- | | `matchDobs` | `match.dobs` | | `inputDob` | `input.dob` | | `comparisonMode` | `strict` | ### Note The`comparisonMode `accepts `strict` or `weakContainment` formats. By default, the `name` functions are set to to `weakContainment`, and the `date-of-birth` functions are set to strict.