Skip to content
This repository was archived by the owner on Sep 19, 2021. It is now read-only.

usps.md

Latest commit

 

History

History
18 lines (10 loc) · 1.25 KB

usps.md

File metadata and controls

18 lines (10 loc) · 1.25 KB

USPS Web Tools

eApp optionally uses the United States Postal Service (USPS) Web Tools APIs to verify address information.

To enable address validation:

  1. Register with the USPS

    • @gsa.gov email servers block the registration email sent by registration@shippingapis.com. It looks too much like spam and doesn't even make it to the spam folder. Try registering with an alternative email address if the registration email does not arrive within a few minutes.

  2. Configure the Web Tools username

    • In the .env file used to build eApp (or at runtime in the eApp API backend process environment), set the USPS_API_API_KEY environment variable to the value of the username (e.g., USPS_API_API_KEY=123ABCDE4567).

Notes:

  • The registration email will provide a username and a password. Only the username is required for the API used by eApp.

  • The Development Guide indicates that each website where eApp is deployed should have a unique API username. If username reuse is detected, the application could be subject to immediate loss of access to the USPS server.