Authentication

Getting your API Key

As soon as you sign up for the Scan Documents Dashboard, you will be able to generate an API Key. Under the free plan, you will be able to execute up to 25 free requests. Then, you will need to upgrade your account to a paid plan to continue using the API.

You can create your API key in the API Dashboard by clicking on the "Create API Key" button at the top right corner of the API Keys page.

Your API Key will be generated and displayed in a modal. Copy it and store it in a safe place!

Using Your API Key

To authenticate your requests to the Scan Documents API, you need to include your API key in the x-api-key header of your request. Here is an example of how to do this using curl:

curl -X GET https://api.scan-documents.com/v1/files \
-H "x-api-key: YOUR_API_KEY"
-H "Content-Type: application/json"

Request that are not authenticated with a correct API key will receive a 401 Unauthorized response.

Removing an API Key

Sometimes you may want to remove an API key. You can do this by clicking on the button with the trash icon next to the API key you want to remove.

This will remove the API key from your account, and it will no longer be valid for authentication.

The Next Steps

Now that you have your API key, you can start making requests to the Scan Documents API. Start by uploading a file and operating on it. See our Quick Start Guide for more information on how to do this.