Address cleansing status fields
Learn about address cleansing status fields.
During address cleansing, the system returns both cleansed address fields and verification status fields when an address is verified.
If the address isn't verified, no address fields are returned. To return only verification status fields for unverified addresses, enable the returnUnverifiedStatus option. For details, see Address Cleansing Properties.
Some of the following status fields depend on the cleansing process or country-specific reference data.
These status fields indicate how each address component was processed during cleansing; whether it was verified, changed, added, or left unrecognized.
| Fields | Description |
|---|---|
AVC, VerificationStatus, and VerificationStatusDetails |
For more information about these fields, see topic Understanding Address Verification Code. |
DPVConfirmedIndicator, DPVFootnotes, and ResultsString
|
These fields are returned only when the CASS2 process is used.
Note:
For more information about these fields, see the CASS2 Field Descriptions page. |
SerpStatusEx, Questionable, and Result
| These fields are returned only when the SERP process is used. Note:
For more information about these fields, see the SERP Fields page. |
| Component-level field status indicators | |
AddressStatus, Address1Status, Address2Status, Address3Status, Address4Status, Address5Status, Address6Status, Address7Status, and Address8Status | Show the verification result for the Address or Address line fields. Values are returned only when returnUnverifiedStatus is set to true. |
DeliveryAddressStatus, DeliveryAddress1Status to DeliveryAddress8Status | Show the verification result for DeliveryAddress fields. Includes per-line indicators when returned. |
CountryStatus | Status code for the Country field after cleansing. |
SuperAdministrativeAreaStatus | Status code for the super administrative area (e.g., regions above state level). |
AdministrativeAreaStatus | Status of the state or province field after address cleansing. |
SubAdministrativeAreaStatus | Status code for county- or district-level administrative areas. |
LocalityStatus | Status of the locality field (e.g., city or municipality). |
DependentLocalityStatus | Status code for dependent locality elements (e.g., neighborhoods). |
DoubleDependentLocalityStatus | Status code for the smallest population areas, often nested within dependent localities. |
ThoroughfareStatus | Status of the street or block address element. |
DependentThoroughfareStatus | Status for any secondary thoroughfare component (e.g., a secondary street name). |
PremiseStatus | Status of the premise number (e.g., house or building number). |
BuildingStatus | Status code for the named building or business location. |
SubBuildingStatus | Status for units within a building (e.g., apartment or suite). |
SubBuildingFloorStatus | Status for the floor identifier in a sub-building, if parsed. |
PostalCodeStatus | Status for the postal code or ZIP Code, including primary and secondary components. |
OrganizationStatus | Status of the organization name at the address, if present. |
PostBoxStatus | Status of the Post Box or PO Box component. |
Each status field provides a Status that explains how the corresponding address component was handled during cleansing. Codes indicate whether the value was verified, corrected, added, identified from context, or left unrecognized.
| Code | Status Name | Description |
| 0 | fsNotApplicable | The field is not applicable for returning a field status code. |
| 1 | fsVerifiedNoChange | The field has been verified using relevant reference data, and no changes were necessary. |
| 2 | fsVerifiedAliasChange | The field has been verified using relevant reference data, and an alias change has been made during parsing. |
| 3 | fsVerifiedSmallChange | The field has been verified using relevant reference data, and a minor spelling correction has been made. |
| 4 | fsVerifiedLargeChange | The field has been verified using relevant reference data, and a major spelling correction has been made. |
| 5 | fsAdded | The field has been added based on relevant reference data. |
| 6 | fsIdentifiedNoChange | The field has been identified using relevant lexicon data, and no changes were necessary. |
| 7 | fsIdentifiedAlias | The field has been identified using relevant lexicon data, and an alias change has been made. |
| 8 | fsIdentifiedContext | The field has been identified using relevant context rules (not strictly reference or lexicon-driven). |
| 9 | fsEmpty | The field is empty. |
| 10 | fsUnrecognized | The field is unrecognized—it could not be identified or verified using reference data, lexicon, or contextual rules. |