---
title: BankValidator overview
summary: High-level purpose, scope, and responsibilities for the BankValidator library.
status: draft
owner: SAIF
last_reviewed: 2026-07-24
library: BankValidator
reference_type: package
---

# BankValidator overview

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

BankValidator is a legacy .NET Framework library that exposes a single façade, `SAIF.clsValidateBank`, for bank-routing validation, company lookup, bank detail retrieval, ATM checks, and SSN validation against Lyons/CBIZ SOAP services.

## Purpose
- Encapsulate vendor SOAP authentication and request execution for bank-validation and identity-validation operations.
- Provide one callable class for ABA validation, bank lookup, ATM participation/status queries, and SSN validation.
- Return bank-detail payloads as XML or as a typed `Institutions` DataSet wrapper.

## Responsibilities
- Manage vendor credentials and logon/logoff calls for ABA, ATM, and SSNKey services.
- Expose configurable service endpoint properties for the generated SOAP clients.
- Normalize selected vendor faults into caller-facing empty results for bank-lookup operations.
- Dispose generated SOAP proxy instances when the façade is released.

## Key components
- `SAIF.clsValidateBank`: Public façade for all supported vendor service operations.
- `SAIF.Institutions`: Auto-generated typed DataSet used to hold bank-detail results loaded from XML.

## 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
- `Legacy\BankValidator\clsValidateBank.vb`
- `Legacy\BankValidator\Institutions.Designer.vb`
- `Legacy\BankValidator\Institutions.xsd`
- `Legacy\BankValidator\SAIF.Legacy.BankValidator.vbproj`
- `Legacy\BankValidator\SAIF.Legacy.BankValidator.nuspec`