This library implements Stamps.com SWSIM v111 for Address cleanse & validation
If you like or are using this project please give it a star. Thanks!
dotnet add package EasyKeys.Shipping.Stamps.AddressValidation builder.Services.AddStampsAddressProvider();
app.MapPost("/addressValidation", async (
AddressValidationDto model,
IStampsAddressValidationProvider addressProvider,
CancellationToken cancellationToken) =>
{
var address = new ValidateAddress(model.Id, model!.Address);
var validatedAddress = await addressProvider.ValidateAddressAsync(address, cancellationToken);
return Results.Json(validatedAddress, options);
});
public class AddressValidationDto
{
public string Id { get; set; } = Guid.NewGuid().ToString();
public Address? Address { get; set; }
}CleanseAddress as the name suggests provides address verification functionality.
SWS/IM requires you to verify the address for all domestic shipments.
Once you have the destination address call CleanseAddress, this will verify the address is valid and also make formatting changes to
meet USPS addressing standard.
When the response is received from the request the AddressMatch and CityStateZipOk fields are checked.
AddressMatch : This is a Boolean value that is True if an exact match was found.
CityStateZipOk : If this is true that means the street address provided could not be verified but the city, state and the zip match each other. In this case, you can continue to print postage for this address but it is probably worth informing the user that the street address could not be verified.
Both fields are recorded in the ValidationBag of the ValidateAddress object.
Addresses cannot be verified for international shipments but we do verify the destination country. Please ensure that you use a country name from the accepted list published here ‐ http://pe.usps.com/text/imm/immctry.htm.
Please note that in order to recieve a successful response sender & recipient contact information must be provided.