API Keys

Authentication and authorization for the EasyPost API are handled via Basic Auth, using an API key as the username without a password. All communications with the EasyPost API must be secured via TLS v1.2. Improper authentication methods, such as HTTP requests or missing API Keys, will result in request failures.

Prerequisites

• Sign up for an EasyPost account. 
• Set up the EasyPost Wallet. 

API Key Types

EasyPost offers Test and Production keys: 

• Test: Enables functionality testing at no cost post-signup.
• Production: Used for live application operations.

Security Practices

API Keys should be treated with the same level of security as passwords and kept confidential. They allow full account access; therefore, exposure to public code or communications should be avoided. A compromised key can be immediately disabled via the API Keys page on the EasyPost Dashboard. 

Obtaining API Keys

1. Login to the EasyPost Dashboard.
2. Navigate to Account Settings. 
3. Select the API Keys tab. 
4. Click the Add Additional API Key dropdown and select Production or Test.
   
   
   The API Keys will be displayed on the dashboard. 
   

Disabling API Keys

1. Login to the EasyPost Dashboard.
2. Navigate to Account Settings. 
3. Select the API Keys tab.
4. Find the API Key to be disabled and move the Status toggle switch to Disabled.
   
    
5. Once the API key is disabled. Select the delete icon to remove the API Key from the dashboard.
   
    
6. Confirm deletion. 
   

FAQ's

Q: Why is the Add Additional API Key button disabled?

There is additional verification that needs to be completed for your account. To have your account reviewed so you can access your keys, please fill out our Security Verification form.