Authentication

Authentication is the process of identifying and verifying the identity of a user making the API call. Mindee API uses API Keys for authentication. The API key is a long string that you usually include either in the request URL or request header.

Avoid exposing your secret API keys on GitHub, in client-side code, or in any other location that is open to the public.

Keep in mind that your API keys has many uses. To get your API key, see Manage V1 API Keys.

You can use a single API key for any of the off-the-shelf APIs; for example, you can use the same API key to access the Invoices API, Receipts API, or any other off-the-shelf APIs from the API store

Authenticate Your API Calls

In order to authenticate your requests, you must include a valid API key using a custom HTTP Authorization header when calling Mindee's REST API, you do not need to provide a password. API requests without authentication will also fail.

Authorization: Token <my-apikey-here>

For each API, you can create as many API keys as you want in the API Key section. See Managing API Keys for more information.

API Key Revocation

You can revoke an API key at any time using the API Key section.

Note: Once an API key is revoked, using it to authenticate your request will lead to a 401 error