---
title: SAIF.Services.CleanAddress overview
summary: High-level purpose, scope, and responsibilities for this library.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-07-24
library: SAIF.Services.CleanAddress
reference_type: package
---

# SAIF.Services.CleanAddress overview

> **Documentation context:** Packaged Component (NuGet)

SAIF.Services.CleanAddress provides a single .NET facade over the CorrectAddress SOAP service so calling applications can request address cleansing, proper-case conversion, batch processing, and ZIP-based city/state/county lookup without handling the vendor's low-level web-service contract directly.

## Purpose
- Provide a reusable address-service wrapper that shields callers from the vendor service's by-reference SOAP interface and raw return-code conventions.
- Return typed results for cleansed addresses, ZIP lookup rows, and batch execution outcomes so consuming applications can work with domain-focused objects instead of transport details.

## Responsibilities
- Invoke the CorrectAddress service for health checks, batch execution, proper-case conversion, ZIP lookup, and address cleansing.
- Translate batch return codes into `BatchReturnTypes` values.
- Parse fixed-width ZIP lookup results into `clsCityStateCountyInfo` objects.
- Convert raw USPS return data, error codes, and barcode fragments into `clsCleanAddressInfo`.

## Key components
- `clsCleanAddress`: Public facade that creates the service proxy and maps vendor responses.
- `clsCleanAddressInfo`: Result object for the main address-cleansing operation.
- `clsCityStateCountyInfo`: Result object for ZIP-based city/state/county lookup.
- `clsBatchReturnInfo`: Result object for batch execution status.
- `BatchReturnTypes`: Enum describing normalized batch return outcomes.

## Related documentation
- [Index](index.md)
- [Architecture](architecture.md)
- [Dependencies](dependencies.md)
- [Operations and processes](operations-processes.md)
- [Business rules](business-rules.md)
- [API reference](api/index.md)

## Sources
- `Services\SAIF.Services.CleanAddress\clsCleanAddress.vb`
- `Services\SAIF.Services.CleanAddress\clsCleanAddressInfo.vb`
- `Services\SAIF.Services.CleanAddress\clsCityStateCountyInfo.vb`
- `Services\SAIF.Services.CleanAddress\clsBatchReturnInfo.vb`
- `Services\SAIF.Services.CleanAddress\mdlEnums.vb`
- `Services\SAIF.Services.CleanAddress\app.config`
- `Services\SAIF.Services.CleanAddress\SAIF.BOF.Services.CleanAddress.vbproj`
- `Services\SAIF.Services.CleanAddress\SAIF.BOF.Services.CleanAddress.nuspec`
- `Services\SAIF.Services.CleanAddress\Web References\CleanAddressSvc\Reference.vb`