---
title: Health check
summary: Confirms that the CorrectAddress vendor service can respond to a request.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-07-30
library: SAIF.Services.CleanAddress
reference_type: package
operation_id: OP-CA-01
trigger: Caller invokes clsCleanAddress.HelloWorld()
---

# Health check

Health check is a lightweight liveness probe for the CorrectAddress vendor service. It creates a fresh SOAP proxy, calls the vendor's `HelloWorld` operation, and returns whatever greeting string the vendor sends back, without any local transformation.

| Field | Value |
| --- | --- |
| **Operation ID** | OP-CA-01 |
| **Trigger** | Caller invokes `clsCleanAddress.HelloWorld()` |
| **Inputs** | None |
| **Outputs** | Service greeting `String` returned by the vendor |
| **Primary components** | `clsCleanAddress.HelloWorld`, `CleanAddressSvc.clsCAServices` |
| **Entry point** | `Services\SAIF.Services.CleanAddress\clsCleanAddress.vb` |

## Steps

1. Create a new `CleanAddressSvc.clsCAServices` proxy instance.
2. Set `AllowAutoRedirect = True` and `UseDefaultCredentials = True` on the proxy.
3. Call the vendor `HelloWorld()` operation and return its response string directly to the caller, with no parsing or classification applied.

## Process flow

The following diagram visualizes this operation's control flow.

```mermaid
flowchart TD
	Start([Caller invokes HelloWorld]) --> Proxy[Create clsCAServices proxy]
	Proxy --> Configure[Set AllowAutoRedirect<br>and UseDefaultCredentials]
	Configure --> Call[Call vendor HelloWorld]
	Call --> Return([Return greeting string])
```

## Failure and edge-case behavior

- The vendor call is not wrapped in a `Try/Catch`; a SOAP fault or transport error propagates to the caller unhandled, unlike [Address cleanse](address-cleanse.md), which does catch exceptions.*
- Success depends entirely on the hosting process identity because `UseDefaultCredentials = True` is set before the call.

> **Note:** Statements marked with `*` were inferred from code structure, naming
> conventions, or contextual evidence where direct confirmation was not available
> in source artifacts.

## Related documentation
- [Operations and processes](../operations-processes.md)
- [Business rules](../business-rules.md)

## Sources
- `Services\SAIF.Services.CleanAddress\clsCleanAddress.vb`
- `Services\SAIF.Services.CleanAddress\Web References\CleanAddressSvc\Reference.vb`