USPS API Address Checker

USPS Setup

1. Log In/Create USPS Business Account

Use the USPS Customer Onboarding Portal (COP) (https://cop.usps.com/cop-navigator?wf=API&showCC=false), sign into your USPS Business Account, or create a new USPS Business Account. The COP will ensure that your USPS Business Account is configured for the USPS APIs.

2. Log In

Log in to the USPS Developer Portal (https://developers.usps.com/saml_login) using your USPS Business Account credentials from Step 1.

3. Create an App

After logging into the Developer Portal, click the Apps button from the Menu Bar and complete the following steps to create an App:

A.Click "Add App" B.Enter your App Name (required) (e.g., KempsPrime) C.Enter your Callback URL (optional) D.Check the box to accept Terms and Conditions and Privacy Policy (this may not appear) E.Enter Description (optional) F.Select API Product (required) G.Click "Add App"

4. Retrieve your Consumer Key and Secret

Select your App and retrieve your Consumer Key and Consumer Secret from the Credentials section. These credentials are required for Prime Setup (below) and for generating the OAuth Token.

5. Authorize App to Access Protected Information Resources

Enter your Consumer Key here to authorize your App to access your payment accounts, permits, CRIDs, MIDs, and subscriptions, which will be required by several USPS APIs.

Prime Setup

1. Access the "USPS Address Validator - Account Settings" page. This may commonly be found in Admin--> Custom Admin page.

2. Enter the USPS API Key and Secret provided above. If no information is entered in the Username and Password fields, you can enter a simple string, like "Prime16" to make sure those fields have an entry.

3. Use the "Test USPS API Settings" button to test your API Key and Secret, ensuring your system can communicate with and connect to the USPS API system. You should see a "Settings appear to work properly" message if everything worked.

4. You can also test using a case to ensure the settings are being used.