Understanding the API Key lifecycle

Understanding the API Key lifecycle

API keys are unique identifiers used to authenticate access to Sandbox APIs. They verify the identity of the requesting application and ensure secure, reliable communication with Sandbox services. 

API Keys Lifecycle

Sandbox API keys can exist in the following states:

  • Active – You can make API calls to production without any restriction
  • Inactive – Your plan is inactive and you won't be able to make API calls to production or test environment.
  • Halted – You have exhausted your plan quota and all further API calls will fail. You can upgrade or enable overdraft to make your API key active again.

💡 Enable overdraft to continue using APIs after reaching the quota.

  • Restricted – The wallet balance is less than zero (negative), restricting access to Paid APIs, that incur wallet charges. Note, you'd still be able to make calls to other APIs.

💡 Learn how to add funds to your wallet.


Facing a problem? Create a ticket and we'll handle it from here.