Resolution Rule Chain variables

Add context to your resolution rule chains.

AML Resolution Rule Chain 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.

FieldDescription
applicantInformation about the applicant.
applicantIdDocApplicant ID document type.
inputAML case input information.
screeningAML screening results.
matchAML hit information.

Input

The table below outlines input variables that contain the essential data about the screened entity.

FieldDescription
firstNameApplicant's first name.
firstNameEnApplicant's transliterated first name.
lastNameApplicant's last name.
lastNameEnTransliterated applicant's last name.
middleNameApplicant's middle name.
middleNameEnApplicant's transliterated middle name.
fullNameApplicant's full name.
aliasNameAlias of the screened entity. For French passports, this field contains the value of the epouse field.
genderApplicant's gender.
dobApplicant's date of birth.
countryApplicant's country in the ISO 3166-1 alpha-3 format.
townApplicant's town.
stateApplicant's state.
companyInfoApplicant's company info.
countriesApplicant's countries in the ISO 3166-1 alpha-3 format.
entityTypeApplicant entity type.
  • individual — for applicants registered and checked as individuals.
  • company — for applicants registered and checked as legal entities.
countryOfBirthApplicant's country of birth in the ISO 3166-1 alpha-3 format.
nationality Applicant's nationality in the ISO 3166-1 alpha-3 format.
analysisRisk signals based on the input data.

Screening

The table below outlines the variables related to AML screening results.

FieldDescription
idAML case ID.
createdAtAML case creation date.
targetEntityTypeTarget entity type: applicant or transaction participant.
vendorAML screening provider.
hitsCountMatches count.
riskLabelsRisk labels collected from all matches in the case.
matchStatusesMatches match statuses collected from all matches in the case.
answerThe GREEN/YELLOW/RED/ERROR answer of the check.
tagsAML 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.

FieldDescription
nameMatch name.
alternativeNamesMatch alternative names.
dobsDoBs listed in the match.
riskLabelsAML case risk labels.
previousReviewPrevious case review dates.
complyAdvantageComplyAdvantage-specific match information.
complyAdvantageMeshComplyAdvantage-specific mesh information.
worldCheckOneWorld Check One-specific match information.
quantifindQuantifind-specific match information.
analysisSignals based on match data.
sourcesSignals based on match source.
countriesCountries related to this match.
genderGender of the matched entity. Null if not available or ambiguous.

input.companyInfo

The table below outlines the variables related to the applicant company.

FieldDescription
nameApplicant's company name.
alternativeNamesAlternative applicant's company name.

input.analysis

The table below outlines the variables related to the applicant’s personal details.

FieldDescription
parentNameParent name extracted from input data.
namesCountWords or hieroglyphs count in the applicant’s name.

screening.targetEntityType

The table below outlines the variables related to transaction participants.

FieldDescription
applicantApplicant data.
transactionParticipantTransaction participant role.

screening.vendor

The table below outlines the variables related to the screening service provider.

FieldDescription
complyAdvantageCSOMComply Advantage.
worldCheckOneWorld Check One.
quantifindQuantifind Graphyte.
complyAdvantageMeshComply Advantage Mesh.

match.dobs

The table below outlines the variables related to applicants' DoBs.

FieldDescription
hasDataDoB data is present.

match.previousReview

The table below outlines the variables related to previous reviews of the detected match.

FieldDescription
matchStatusMatch status.
riskLevelRisk level.
whitelistedWhitelisted status.
modifiedAtDate of last review modification.
noteNote left by a reviewer.

match.complyAdvantage

The table below outlines the variables related to previous reviews of the detected match.

FieldDescription
warningTypesVendor-specific warning type, such as pep or sanctions.
matchTypesMatch 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.

FieldDescription
warningTypesVendor-specific warning type, such as pep or sanctions.
resolutionDateHit resolution date.
matchStatusMatch status based on the resolution toolkit.
riskLevelRisk level based on the resolution toolkit.

match.quantifind

The table below outlines the variables related to previous reviews of the detected match.

FieldDescription
riskLevelRisk level.
confidenceQuantifind-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.

FieldDescription
parentNameApplicant's parent name extracted from match data.
tinCompatibleThe results of the matching of the applicant’s TIN to the national ID.
namesCountWords or hieroglyphs count in the applicant’s name.

match.sources

The table below outlines the variables related to previous reviews of the detected match.

FieldDescription
earliestStartDateEarliest startDate value among all sources. Returns null if all source startDate values are null.
latestEndDateLatest endDate value among all sources. Returns null if all source endDate values are null.

match.countries

The table below outlines the variables related to previous reviews of the detected match.

FieldDescription
allDeduplicated union of all country codes across every role.
locationCountries associated with the entity's physical location.
placeOfBirthCountries associated with the entity's place of birth.
placeOfDeathCountries associated with the entity's place of death.
operatesInCountries in which the entity operates.
registeredInCountries in which the entity is registered.
vesselFlagFlag countries for vessels associated with the entity.

Functions

The table below outlines the variables related to the functions of the selected rules.

FieldParametersDescription
namesCompatiblematch—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.
namesIncompatiblematch—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.
dobsCompatibledobs—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.
dobsIncompatibledobs—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.


Did this page help you?