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.

API keys are valid for 1 year.

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

Learn how to create and regenerate an API key below

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.

Anywhere you have used you aCheck API will need to be updated with the newly generates API key to prevent unwanted errors