Understanding the Minimum Verification Level

The MinimumVerificationLevel option is used to specify the minimum verification level that a record must reach in order to avoid reversion.

The default value is 0 and valid values are 0-5. Wherein,
  • 5 indicates Delivery Point (PostBox or SubBuilding)
  • 4 indicates Premise (Premise or Building)
  • 3 indicates Thoroughfare
  • 2 indicates Locality or PostalCode
  • 1 indicates AdministrativeArea
  • 0 indicates None

If the MinimumVerificationLevel option is set to a specific value, but the cleansing service is unable to verify (as per the Pre-Processed Verification Level of AVC) to that level, then the address remains uncleansed.

Take a look at the address sample and the table below, to understand how the MinimumVerificationLevel option works.

Request Body - Address Sample

[
 {
   "pcde": "00725",
   "admn": "PR",
   "add1": "Cond Islabella",
   "lcty": "Caguas"
 }
]
Table 1. Understanding the Minimum Verification Level
Minimum Verification Level Output Details
When the MinimumVerificationLevel is not set (Default value is 0)
[ 
   { 
      "results":[ 
         { 
            "Building":"Cond Islabella",
            "ResultClassification":"RES_REVIEW",
            "PremiseNumber":"225",
            "Address":"Cond Islabella<BR>225<BR>Caguas PR 00727",
            "CountryName":"United States",
            "DeliveryAddress":"Cond Islabella<BR>225",
            "LocalityStatus":"fsVerifiedNoChange",
            "PostalCode":"00727",
            "DeliveryAddress2":"225",
            "ISO3166-2":"US",
            "Premise":"225",
            "ISO3166-3":"USA",
            "DeliveryAddress1":"Cond Islabella",
            "PostalCodePrimary":"00727",
            "AdministrativeArea":"PR",
            "ISO3166-N":"840",
            "Locality":"Caguas",
            "Address2":"225",
            "Address3":"Caguas PR 00727",
            "Address1":"Cond Islabella",
            "AVC":"P44-I44-P5-095",
            "PremiseNumberStatus":"fsAdded",
            "SubAdministrativeArea":"Caguas",
            "AdministrativeAreaStatus":"fsVerifiedNoChange",
            "MatchRuleLabel":"1"
         }
      ],
      "status":"OK"
   }
]
The output returns a cleansed address with additional information. Wherein, "AVC":"P44-I44-P5-095" indicates that the address is partially verified to level 4 (Premise or Building).

Suppose, you do not want an address to be considered as cleansed if it does not meet your defined level (for example, 5). Then, in that case, you can use the MinimumVerificationLevel option to define a desired level for verification. To know how the sample address works when the MinimumVerificationLevel is set to 5 , see the response below.

When the MinimumVerificationLevel is set to 5
[ 
   { 
      "results":[ 
         { 
            "AdministrativeArea":"PR",
            "ResultClassification":"RES_REJECTED",
            "Address":"Caguas PR 00725",
            "Locality":"Caguas",
            "LocalityStatus":"fsUnrecognized",
            "PostalCode":"00725",
            "Address1":"Caguas PR 00725",
            "AdministrativeAreaStatus":"fsUnrecognized",
            "AVC":"R22-I33-P6-100"
         }
      ],
      "status":"OK"
   }
]
The output indicates that the cleansing service was unable to verify as per the defined level 5.

Hence, the output returned is not a cleansed address and only consists of the input fields that were part of the request body. Wherein,

  • "AVC":"R22-I33-P6-100" - Indicates that the cleansing service was able to verify upto level 2 (Locality or PostalCode), which did not equal to the minimum verification level set to 5 (Delivery Point (PostBox or SubBuilding)).
  • "ResultClassification":"RES_REJECTED" - Indicates that the address is rejected.