VisusIO.AddressValidation.Integration.PitneyBowes 1.0.0-preview.1

This is a prerelease version of VisusIO.AddressValidation.Integration.PitneyBowes.
dotnet add package VisusIO.AddressValidation.Integration.PitneyBowes --version 1.0.0-preview.1
                    
NuGet\Install-Package VisusIO.AddressValidation.Integration.PitneyBowes -Version 1.0.0-preview.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="VisusIO.AddressValidation.Integration.PitneyBowes" Version="1.0.0-preview.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="VisusIO.AddressValidation.Integration.PitneyBowes" Version="1.0.0-preview.1" />
                    
Directory.Packages.props
<PackageReference Include="VisusIO.AddressValidation.Integration.PitneyBowes" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add VisusIO.AddressValidation.Integration.PitneyBowes --version 1.0.0-preview.1
                    
#r "nuget: VisusIO.AddressValidation.Integration.PitneyBowes, 1.0.0-preview.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package VisusIO.AddressValidation.Integration.PitneyBowes@1.0.0-preview.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=VisusIO.AddressValidation.Integration.PitneyBowes&version=1.0.0-preview.1&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=VisusIO.AddressValidation.Integration.PitneyBowes&version=1.0.0-preview.1&prerelease
                    
Install as a Cake Tool

AddressValidation

GitHub Actions Workflow Status Sonar Quality Gate Sonar Coverage

Static Badge

Package Version Downloads
VisusIO.AddressValidation NuGet Version NuGet Downloads
VisusIO.AddressValidation.Integration.FedEx NuGet Version NuGet Downloads
VisusIO.AddressValidation.Integration.Google NuGet Version NuGet Downloads
VisusIO.AddressValidation.Integration.PitneyBowes NuGet Version NuGet Downloads
VisusIO.AddressValidation.Integration.Ups NuGet Version NuGet Downloads

AddressValidation is a .NET library that provides a unified, provider-agnostic API for validating physical mailing addresses.

AddressValidation supports trimming and native AOT deployments.

Integrations

Service Coverage Status
FedEx® Address Validation API 46 countries Status
Google Address Validation API 39 countries Status
Pitney Bowes Address Validation API United States Status
UPS® Address Validation API United States Status
USPS® Address Validation API United States Status

Quick Start

Installation

Install the integration package for your chosen provider via the .NET CLI:

dotnet package add VisusIO.AddressValidation.Integration.FedEx

Registration

All integrations require HybridCache for OAuth token caching. Register it alongside the integration at application startup:

builder.Services.AddHybridCache();
builder.Services.AddFedExAddressValidation();

Configuration

Configuration is read from appsettings.json under the AddressValidationSettings:<Provider> section. For FedEx:

{
  "AddressValidationSettings": {
    "FedEx": {
      "AccountNumber": "<your account number>",
      "ClientId": "<your client id>",
      "ClientSecret": "<your client secret>",
      "ClientEnvironment": "PRODUCTION"
    }
  }
}
Property Required Description
AccountNumber Yes Your FedEx account number
ClientId Yes OAuth 2.0 client ID
ClientSecret Yes OAuth 2.0 client secret
ClientEnvironment No PRODUCTION, DEVELOPMENT, or SANDBOX. Defaults to DEVELOPMENT

ClientId and ClientSecret should be stored encrypted at rest. See Security in the documentation for recommended approaches.

Each provider has its own set of configuration properties. See the documentation for the full reference.

Usage

Inject IAddressValidationService<TRequest> into your service or controller and call ValidateAsync:

public class ValidateController
{
    private readonly IAddressValidationService<FedExAddressValidationRequest> _validationService;

    public ValidateController(IAddressValidationService<FedExAddressValidationRequest> validationService)
    {
        _validationService = validationService ?? throw new ArgumentNullException(nameof(validationService));
    }

    [HttpPost]
    public async Task<IActionResult> Post([FromBody] FedExAddressValidationRequest request, CancellationToken cancellationToken = default)
    {
        IAddressValidationResponse? response = await _validationService.ValidateAsync(request, cancellationToken);

        return response is null
            ? new NotFoundResult()
            : response.Errors.Count > 0
                ? new UnprocessableEntityObjectResult(response)
                : new OkObjectResult(response);
    }
}

Each integration package exposes its own TRequest type (e.g., FedExAddressValidationRequest, GoogleAddressValidationRequest) and a corresponding Add*AddressValidation() extension method. See the documentation for provider-specific options.

Documentation

Full documentation is available at https://ave.projects.visus.io/.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0-preview.1 46 7/5/2026