Conditional node variables
Build conditions effectively with the help of pre-programmed variables.
The Workflow builder's conditional nodes help you easily manage verification flows depending on a certain criteria.
This article lists all the conditional node variables available for selection. Some of the variables have nested attributes and elements.
Note
Fields correlating to the products that you did not enable on your account will not be available.
Root variables
The table below outlines root variables that are the most essential fields of the conditional nodes.
Field | Description |
---|---|
applicant | Branch of items related to information about an applicant. |
poi, poi2, poi3, poi4 | Fields identifying the proof of identity document conditions. |
poa, poa2 | Items associated with the proof of address document. |
device | Fields including information about an applicant's device. |
questionnaires | Questionnaire item values nested by questionnaire, section, and then item id. E.g. questionnaire["myQuestionnaireId"]["mySectionId"]["myItemId"] |
clientLists | Field identifying client lists by name. |
checks | Items including the Background checks information. |
random | Field standing for a random value from 0.0 to 1.0 . |
applicant
Field | Description |
---|---|
id | Applicant ID. |
externalUserId | Value you passed to externalUserId during applicant creation, usually applicant id on your side. |
createdAt | Applicant creation date. |
fullName | Applicant's full name. |
country | Applicant's country as per ISO 3166-1 alpha-3. |
countryOfBirth | Applicant's country of birth as per ISO 3166-1 alpha-3. |
info | Information extracted from documents or external databases. |
fixedInfo | Basic applicant information as provided to the Sumsub SDK/API. |
review | Applicant's review. |
sourceKey | Applicant's source key. |
derivatives | Various information derived from an applicant. |
metadata | Applicant's metadata. |
riskLabels | Applicant risk labels. |
riskLabelstags | Applicant tags. |
assessment | Applicant assessment. |
email | Applicant's email information. |
phone | Applicant's telephone data. |
emailDomain | Applicant email's domain name. |
type | Applicant entity type: individual or company. |
agreement | Applicant agreement data. |
poi, poi2, poi3, poi4
Field | Description |
---|---|
country | Country where an identity document was issued (ISO 3166-1 alpha-3). |
idDocType | Identity document type. |
number | Identity document number. |
additionalNumber | Identity document additional number. |
dob | Date of birth of an identity document owner. |
nationality | Nationality of an identity document owner. |
placeOfBirth | Place of birth of an identity document owner. |
issuedDate | Date of an identity document's issue. |
issueAuthority | Authority that issued an identity document. |
issueAuthorityCode | Unique code of the authority that issued an identity document. |
validUntil | Validity date of an identity document. |
validityPeriod | Validity period of an identity document. |
firstIssuedDate | Date of an identity document's first issue. |
metadata | Metadata related to an identity document. |
address | Address specified in an identity document. |
category | Identity document category, e.g., category of a driver's license. |
nfc | NFC information on an identity document. |
fullMrz | Machine-Readable Zone lines separated by the (\n) symbol. |
poa, poa2
Field | Description |
---|---|
country | Country where the proof of address document was issued (ISO 3166-1 alpha-3). |
idDocType | Document type. |
number | Document number. |
metadata | Metadata related to a proof of address document. |
address | Address specified in a proof of address document. |
detectedLanguages | List of languages detected in a proof of address document specified in the format of 2-letter codes (ISO 639-1). |
device
Field | Description |
---|---|
ipCountry | An IP Address country (ISO 3166-1 alpha-3). |
ipStateCode | A code of the state or region pointed by IP. |
checks
Field | Description |
---|---|
poa | Proof of address information (UTILITY_BILL). |
poa2 | 2nd proof of address information (UTILITY_BILL2). |
company | Business verification information. |
personWatchlist | Watchlists matching an applicant. |
date
Field | Description |
---|---|
timestamp | Unix timestamp in milliseconds. |
yyyymmdd | Numeric day in YYYYMMDD format, e.g. 20230123 . |
year | Year. |
month | Months of the year (start from 1). |
dayOfMonth | Day of the month (starts from 1). |
ageInYears | Time delta in years between this date and now. |
ageInDays | Time delta in days between this date and now. |
applicant.info, applicant.fixedInfo
Field | Description |
---|---|
country | Applicant's country (ISO 3166-1 alpha-3). |
countryOfBirth | Applicant's country of birth (ISO 3166-1 alpha-3). |
firstName | Applicant's first name. |
firstNameEn | Transliterated first name. |
middleName | Applicant's middle name. |
middleNameEn | Transliterated middle name. |
lastName | Applicant's last name. |
lastNameEn | Transliterated last name. |
gender | Applicant's gender (M or F). |
nationality | Applicant's nationality (ISO 3166-1 alpha-3). |
taxResidenceCountry | Applicant's Tax Residence Country (ISO 3166-1 alpha-3) |
residenceCountry | Applicant's Residence Country (ISO 3166-1 alpha-3) |
age | Applicant's age. |
address | Applicant's address. |
companyInfo | Company information (Business verification). |
tin | Applicant's Individual Taxpayer Identification Number. |
phone | Applicant's telephone data. |
applicant.review
Field | Description |
---|---|
levelName | Applicant level. |
decision | Review of the decision. |
reviewAnswer | Review of the answer. |
attemptCnt | Number of attempts. |
rejectLabels | List of rejection labels. |
buttonIds | List of button ids. |
applicant.derivatives
Field | Description |
---|---|
estimatedAge | Applicant's estimated age. |
applicant.riskLabels
Field | Description |
---|---|
email | Email risk labels. |
phone | Phone risk labels. |
device | Device risk labels. |
crossCheck | Cross-check risk labels. |
selfie | Selfie risk labels. |
aml | AML risk labels. |
person | Person risk labels. |
company | Company risk labels. |
applicant.assessment
Field | Description |
---|---|
scores | Applicant's risk assessment score that is calculated via the transactions monitoring tags. |
phone
Field | Description |
---|---|
number | Applicant's phone number. |
country | Phone number's country. |
applicant.type
Field | Description |
---|---|
individual | Individual applicant. |
company | Company applicant. |
applicant.agreement
Field | Description |
---|---|
createdAt | Date and time (GMT) when the applicant confirms their consent to the submitting and processing of personal data. |
validityPeriod
Field | Description |
---|---|
millis | Validity period of a document in milliseconds. |
days | Validity period of a document in days. |
hours | Validity period of a document in hours. |
minutes | Validity period of a document in minutes. |
seconds | Validity period of a document in seconds. |
address
Field | Description |
---|---|
country | Country code (ISO 3166-1 alpha-3). |
formattedAddress | Address in an human-readable format. |
state | Name of the state or region if applicable. |
town | Name of the town if applicable. |
street | Name of the street if applicable. |
subStreet | Name of the sub-street if applicable. |
postCode | Post code if applicable. |
nfc
Field | Description |
---|---|
fullMrz | Full MRZ data. |
checks.poa, checks.poa2
Field | Description |
---|---|
companyType | Proof of address company type. |
subType | Proof of address sub type if applicable. |
checks.company
Field | Description |
---|---|
answer | The answer on the business verification results. The possible items for the field are: GREEN , RED , YELLOW , IGNORED , ERROR . |
checks.personWatchlist
Field | Description |
---|---|
matchStatuses | Watchlist match statuses for the person. The possible statuses are: unknown , no_match , potential_match , false_positive , or true_positive . |
applicant.info.companyInfo, applicant.fixedInfo.companyInfo
Field | Description |
---|---|
country | Company's country (ISO 3166-1 alpha-3). |
type | Type of entity. |
companyName | Company's name. |
registrationNumber | Company's registration number. |
applicant.review.decision
Field | Description |
---|---|
approved | Decision identifying that an applicant has been approved. |
rejected | Decision identifying that an applicant has been rejected. |
resubmission | Decision identifying that an applicant has been returned for resubmission. |
applicant.review.reviewAnswer, checks.company.answer
Field | Description |
---|---|
IGNORED | Check was skipped. |
GREEN | Successful result of the verification and/or check. |
YELLOW | There are some warnings regarding the verification and/or check. |
RED | Violations were found. |
ERROR | Error occurred during verification. |
Elements of applicant.review.rejectLabels
Field | Description |
---|---|
FORGERY | Forgery attempt was recognized. |
CRIMINAL | Applicant is involved in the illegal actions. |
DOCUMENT_TEMPLATE | Submitted documents are templates downloaded from the internet. |
LOW_QUALITY | Documents have low-quality that doesn't allow definitive decisions to be made. |
SPAM | Applicant was created by mistake or is just a spam user (irrelevant images were supplied). |
NOT_DOCUMENT | Submitted documents aren't relevant for the verification procedure. |
SELFIE_MISMATCH | Applicant's photo (profile image) doesn't match a photo on the provided documents. |
ID_INVALID | Document that identifies a person (like a passport or an ID card) is not valid. |
DOCUMENT_DEPRIVED | Applicant has been deprived of the document |
FOREIGNER | Rejection label associated with the applicants from an unsupported country or e.g. without a residence permit. |
DUPLICATE | Applicant has multiple accounts while duplicates aren't allowed by the regulations. |
BAD_AVATAR | Applicant's avatar doesn't meet the client's requirements. |
WRONG_USER_REGION | Applicant from a region/country which is not allowed to be registered. |
WRONG_ADDRESS | Address from the applicant's documents doesn't match the address entered by them manually. |
INCOMPLETE_DOCUMENT | Some information is missing from the document, or it's partially visible. |
BLACKLIST | Applicant is blocklisted by Sumsub. |
BLOCKLIST | Applicant is blocklisted by a client. |
OTHER | There is some unclassified reason of rejection. |
UNSATISFACTORY_PHOTOS | There were problems with the photos during verification, like poor quality or masked information. |
GRAPHIC_EDITOR | Document has been edited by a graphical editor. |
DOCUMENT_PAGE_MISSING | Some pages of a document are missing (if applicable). |
DOCUMENT_DAMAGED | Document is damaged. |
DIGITAL_DOCUMENT | Document is digital and cannot be accepted |
REGULATIONS_VIOLATIONS | Some violations of the regulations were found. |
INCONSISTENT_PROFILE | Data or documents of different persons were uploaded to one applicant. |
PROBLEMATIC_APPLICANT_DATA | Applicant data doesn't match the data in their documents. |
ADDITIONAL_DOCUMENT_REQUIRED | Additional documents are required to pass the check. |
AGE_REQUIREMENT_MISMATCH | Age requirement is not met (e.g. can't rent a car to a person below 25yo). |
REQUESTED_DATA_MISMATCH | Provided information doesn't match with the data recognized from a document. |
EXPERIENCE_REQUIREMENT_MISMATCH | Applicant doesn't have enough experience (e.g. driving experience is not enough). |
COMPROMISED_PERSONS | Applicant doesn't correspond to Compromised Person Politics. |
PEP | Applicant belongs to the PEP category. |
ADVERSE_MEDIA | Applicant was found in the adverse media. |
FRAUDULENT_PATTERNS | There was fraudulent behavior detected during the verification. |
SANCTIONS | Applicant was found on the sanction lists. |
NOT_ALL_CHECKS_COMPLETED | Not all of the checks were completed. |
FRONT_SIDE_MISSING | Front side of the document is missing. |
BACK_SIDE_MISSING | Back side of the document is missing. |
SCREENSHOTS | Applicant uploaded screenshots. |
BLACK_AND_WHITE | Applicant uploaded black and white photos of their documents. |
INCOMPATIBLE_LANGUAGE | Document's translation is required. |
EXPIRATION_DATE | Applicant uploaded an expired document. |
UNFILLED_ID | Applicant uploaded the document without signatures and stamps. |
BAD_SELFIE | Applicant uploaded a selfie in poor quality. |
BAD_VIDEO_SELFIE | Applicant uploaded a video selfie in poor quality. |
BAD_FACE_MATCHING | Face check between a document and a selfie was failed. |
BAD_PROOF_OF_IDENTITY | Applicant uploaded a poor quality ID document. |
BAD_PROOF_OF_ADDRESS | Applicant uploaded a poor quality proof of address. |
BAD_PROOF_OF_PAYMENT | Applicant uploaded a poor quality proof of payment. |
SELFIE_WITH_PAPER | Special selfie is required (e.g. selfie with a piece of paper and date on it). |
FRAUDULENT_LIVENESS | There was an attempt to bypass liveness check. |
OK | Custom reject label. |
COMPANY_NOT_DEFINED_STRUCTURE | Entity's control structure wasn't defined. |
COMPANY_NOT_DEFINED_BENEFICIARIES | Entity's beneficial owners weren't identified and duly verified. |
COMPANY_NOT_VALIDATED_BENEFICIAL_OWNERS | Not all beneficial owners have passed the identity verification procedure. |
COMPANY_NOT_VALIDATED_BENEFICIARIES | Entity's Beneficiaries weren't validated. |
COMPANY_NOT_VALIDATED_DIRECTORS | Not all directors have passed the identity verification procedure. |
COMPANY_NOT_DEFINED_REPRESENTATIVES | Entity's representatives weren't defined. |
COMPANY_NOT_VALIDATED_REPRESENTATIVES | Entity's representatives weren't validated. |
UNSUITABLE_DOCUMENT | Document either doesn't fit the required type or lacks obligatory elements, like seal, apostille, or notary certification. |
OUTDATED_DOCUMENT_VERSION | Based on the publicly available state company register, not the most recent version was provided. |
COMPANY_NOT_DEFINED_OWNERSHIP_STRUCTURE | Company ownership structure hasn't been specified or differs from the one declared by the corporate documents. |
COMPANY_INACTIVE_ENTITY | According to the publicly available state company registry, the entity is inactive / dissolved / deregistered. |
COMPANY_INCORRECT_DATA | Provided company attributes like Name, Registration, or Tax Number don't match the provided documents or the state company registry. |
APPLICANT_INTERRUPTED_INTERVIEW | Applicant refused to finish the interview on the video ident call. |
DOCUMENT_MISSING | Applicant refused to show or didn't have required documents on the video ident call. |
UNSUITABLE_ENV | Applicant is either not alone or nor visible on the video ident call. |
CONNECTION_INTERRUPTED | Video Ident call connection was interrupted. |
UNSUPPORTED_LANGUAGE | Video Ident' applicant do not speak language common to operator. |
THIRD_PARTY_INVOLVED | Video Ident applicant trying to pass verification to pass account to a third party. |
INCORRECT_SOCIAL_NUMBER | Incorrect TIN/SSN was provided to perform the check. |
CHECK_UNAVAILABLE | External database service is not available at the moment. |
DB_DATA_NOT_FOUND | Data not found in external database. |
DB_DATA_MISMATCH | Input/document data does not match data from external database. |
Elements of applicant.riskLabels.email
Field | Description |
---|---|
mediumRisk | Medium-risk email address. |
highRisk | High-risk email address. |
disposable | Temporary email address which is provided by a disposable email service and usually expires in a few minutes. |
noWebRegistrations | Email registration is not detected. |
noWebsiteExists | Email domain does not exist. |
nonDeliverable | Messages fail to be delivered to this email address. |
invalidEmail | Email address is invalid. |
Elements of applicant.riskLabels.phone
Field | Description |
---|---|
mediumRisk | Medium-risk phone number. |
highRisk | High-risk phone number. |
virtual | Virtual phone that allows a user to make calls through the internet and is not associated with a physical location. |
noWebRegistrations | Phone number registration is not detected. |
disposable | Disposable phone. |
Elements of applicant.riskLabels.device
Field | Description |
---|---|
vpnUsage | VPN usage is detected. |
multipleDevices | Multiple devices were used. |
multipleMobileDevices | Multiple mobile devices were used. |
lengthySession | Session is too long. |
failedSessionContinuation | Session was interrupted. |
distantIpLocations | Login from different and distant IP addresses for a short time interval. |
Elements of applicant.riskLabels.crossCheck
Field | Description |
---|---|
diverseIdDocCountries | Identity documents issued in different countries. |
manyAccountDuplicates | Lots of account duplicates are created. |
accountsInManyServices | The same account is registered in different services. |
addressCountryVsIpCountryMismatch | Physical address in the country mismatches the country IP address. |
idDocCountryVsIpCountryMismatch | Identity document country mismatches the country IP address. |
exifCountryVsIdDocCountryOrIpCountryMismatch | Country detected by EXIF mismatches either the document country or the country IP address. |
Elements of applicant.riskLabels.selfie
Field | Description |
---|---|
asleep | Person in the selfie is actually asleep. |
forced | Person is coerced into verification. |
multipleFaces | Multiple faces are present. |
estimatedAgeMismatch | Estimated age mismatches the age in documents. |
virtualCameraPresent | Virtual (a software-based) camera that simulates a physical camera is detected. |
manyAttempts | Numerous attempts of passing a selfie check. |
sameFaceWithDifferentData | The same face on documents with different data. |
Elements of applicant.riskLabels.aml
Field | Description |
---|---|
pep | Applicant belongs to the PEP (Politically Exposed Person) category. |
sanctions | Applicant was found in sanctions lists. |
terrorism | Applicant is suspected of terrorism. |
crime | Applicant is suspected of criminal activity. |
adverseMedia | Applicant compromising published information that is related to the user was found in the media. |
fitnessProbity | Applicant does not comply with Fitness and Probity regime. The core function of the Fitness and Probity Regime is to ensure that individuals in key and customer facing positions are competent and capable. |
Elements of applicant.riskLabels.person
Field | Description |
---|---|
famousPerson | Applicant is supposedly a famous person. |
strangeName | Applicant has a strange name that does not seem to be a real one. |
noPhoneNamesFromWebServices | No phone names are found in web services. |
phoneNameMismatchFromWebServices | Name mismatch with the names associated with the phone number. |
noEmailNamesFromWebServices | No email names are found in web services. |
emailNameMismatchFromWebServices | Name mismatch with the names associated with the email address. |
Elements of applicant.riskLabels.company
Field | Description |
---|---|
companyAdditionalDataNotFound | Company data not found in the database. |
companyDataMismatch | Company data doesn't match the database data. |
Elements of applicant.assessment.scores
Field | Description |
---|---|
tag | Applicant tag. |
score | Applicant score. |
checks.poa.companyType, checks.poa2.companyType
There are the main types of companies that issue proof of address documents. New values can't be added.
Field | Description |
---|---|
governmentOrganization | Government organization company type. |
utilityProvider | Utility provider company type. |
bank | Bank company type. |
mobileOperator | Mobile operator company type. |
other | Other company type. |
subType, Elements of possibleSubTypes
There are extended POA subtypes listed in the table below. New values creation is available as an additional service: ADVANCED_POA_TYPE_DETECTION
.
Field | Description |
---|---|
statement | Statement proof of address subtype. |
voterRegistration | Voter registration proof of address subtype. |
taxBill | Tax bill proof of address subtype. |
telecom | Telecom proof of address subtype. |
utilityBill | Utility bill proof of address subtype. |
bankStatement | Bank statement proof of address subtype. |
bankLetter | Bank letter proof of address subtype. |
lease | Lease proof of address subtype. |
other | Other proof of address subtype. |
Updated 4 months ago