How to create and Manage your API Key

This guide explains how to create and configure API keys in your Yellowcard API Dashboard. API keys are required to authenticate requests and should be handled securely at all times.

To be able to create an API key, your account must be fully set up, and you must be logged in to the Yellow Card API Dashboard

Follow the steps below:


Step 1: Navigate to the API Keys Section

  1. Log in to your API dashboard. 
  2. Scroll to the API key section.
  3. Click Create New to generate a new key.

Step 2: Configure Your API Key

When creating a new API key, you’ll be prompted to provide the following details:

  • Key Name

    Enter a descriptive name to help you identify the key’s purpose (for example, Sandbox - Payment)

  • Expiry Date

    Set an expiration date for the key to limit its validity and improve security. 

  • Status

    Choose whether the key should be Active or Inactive upon creation.

  • Permissions

    Define the actions this key is allowed to perform. Grant only the permissions required for your use case.


Once all fields are complete, click on Save to generate your API key.


🎉Congratulations, your API key has been created.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.