> For the complete documentation index, see [llms.txt](https://acheck.gitbook.io/help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://acheck.gitbook.io/help/guides/create-qr-codes/api-key.md).

# API key

Learn how to create an API key for using the aCheck API

A valid API key is required to use the aCheck API to generate QR codes.

Treat your API key as you would a password. Do not share your API key with anyone.

{% hint style="warning" %}
API keys are valid for 1 year.&#x20;

aCheck will automatically send you a reminder 1 month before expiry.

Learn how to create and regenerate an API key below
{% endhint %}

## Create an API key

Go to the Config page

Click **Generate** to show the generate API key form

Enter your password to activate the **Generate API key** button

Congratulations. You have created your API key.

### Use your API key

#### Reveal your API key

All API keys in aCheck are hidden as a security precaution.

To see your API key click **Reveal**

#### Copy your API key

To copy your API key click **Copy**. You API key value will be copied to your computer's clipboard. You can then easily paste it somewhere else.

## Regenerate an API key

Go to the Config page

Click **Regenerate** to show the generate API key form

Enter your password to activate the **Regenerate API key** button

Congratulations. You have regenerated your API key.

{% hint style="info" %}
Anywhere you have used you aCheck API will need to be updated with the newly generates API key to prevent unwanted errors
{% endhint %}
