Limited-Use API Keys for Secure Sharing 

API Hub Documentation

  • Getting Started with the API Hub

  • Using Liminal Webhooks to Register for Updates 

  • Getting Started with Carriers

  • Using Liminal APIs 

  • Status & Image APIs with Webhook Calls

Liminal’s Limited-Use API Keys allow you to embed our API in your platforms without compromising security by exposing your primary API keys.  You can use this API to give your customers real-time status & images embedded in web platforms or emails. 

The Limited-Use API supports Status, Estimated Delivery Date, BOL, and Proof. 

Security 

Liminal’s Limited-Use API Key API is designed so that you control access to your data.  When calling the API you use arguments to control both how long the returned key remains valid and how many times it can be used.   

Arguments 

Argument Description Required/Optional 
Carrier The numeric carrier listed on the /tracking page, or the 4-letter SCAC referenced by the carrier in /account/api-keys  Required 
Methods One or more comma-separated methods (status,date,lading,proof,rating), defaults to status Optional 
Count Integer, number of returns allowed Optional 
Duration Length of key validity in seconds, up to 2562000 (30 days), defaults to 300 (5 minutes) Optional 
pro  One of pro, bol, or tracking 
bol  One of pro, bol, or tracking 
tracking  One of pro, bol, or tracking 

Learn More 

Visit Implementing Limited-Use API Keys for detailed instructions and error messages. 

Last Updated | October 3, 2024


Have questions or need some assistance, Drop us a note.

API Hub Documentation

  • Getting Started with the API Hub

  • Using Liminal Webhooks to Register for Updates 

  • Getting Started with Carriers

  • Using Liminal APIs 

  • Status & Image APIs with Webhook Calls