---
title: CleanAddressBatchService
summary: API reference for CleanAddressBatchService.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-09-24
library: SAIF.Services
reference_type: package
---

# CleanAddressBatchService

Implements `ICleanAddressBatchService`, invoking the CorrectAddress vendor service's `RunCleanAddressBatch` operation to process a batch address-cleansing job located at a file path and translating its integer return code into a `BatchReturnType` enum. The type's own XML doc comment marks it "Unsupported — converted over from VB code and only refactored for future reference," indicating it is a legacy/likely-dormant component*.

## Purpose
- Triggers a CorrectAddress batch address-cleansing run against a file path.
- Converts the vendor's raw integer return code into the `BatchReturnType` enum, falling back to `Unknown` for unrecognized codes.

## Context
- Namespace: `SAIF.Services.Utilities.CleanAddress`
- Assembly/package: `SAIF.Services` (packaged inside the `SAIF.SAIFCode.Core` NuGet package)

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| CleanAddressBatchService(...) | `public CleanAddressBatchService(clsCAServices service)` | Wires the CorrectAddress SOAP proxy into the shared base class, applying its default connection settings. |
| RunCleanAddressBatch | `public ICleanedAddressBatchResults RunCleanAddressBatch(string inPath)` | Runs the CorrectAddress batch cleanse for the file at `inPath` and returns the mapped return type plus the raw vendor return code. |
| Dispose() | `public void Dispose()` | Releases the underlying `clsCAServices` proxy connection (inherited from `CleanAddressServiceBase`). |

## Behavioral notes
- Marked in source as "Unsupported" legacy code retained for reference only; treat with caution before using in new workflows*.
- Falls back to `BatchReturnType.Unknown` when the vendor return code does not map to a defined enum value, avoiding an invalid-cast exception.

> **Note:** Statements marked with * were inferred from code structure, naming conventions, or
> contextual evidence where direct confirmation was not available in source artifacts. Statements
> marked with ** could not be confirmed; treat as unknown until verified.

## Sources
- Services/SAIF.Services/Utilities/CleanAddress/CleanAddressBatchService.cs