---
title: "Test authentication"
method: GET
path: "/auth-test"
---

# Test authentication

`GET /auth-test`

## Request

- Base URL: `https://api.diffchecker.com/public`
- URL: `https://api.diffchecker.com/public/auth-test`
- Auth: one of:
  - API key in header `X-Api-Key`
  - API key in query parameter `email`

Verify that your authentication credentials are working correctly.

## Query parameters

- `email` string, email

## Headers

- `Diffchecker-Version` '1'

## Response `200`

Authentication is working correctly.

- object
  - `creditsUsed` integer, required
  - `message` string, required

## Other responses

- `400`: The Diffchecker-Version request header names a version the API does not support.
- `401`: Authentication failed. Provide a valid email or API key. Depending on the failure, the response can include more specific error codes.
- `404`: No endpoint matches the request path.
- `405`: The endpoint exists but does not support the request method. The `Allow` response header lists the methods it does support.
- `415`: The request Content-Type is not one this endpoint accepts. `/text` accepts only application/json; the upload endpoints accept application/json and multipart/form-data.
- `500`: The server hit an unexpected failure while handling the request. A failure after the diff was recorded can still incur charges. Check creditsUsed and X-Credits-Used to determine whether credits were charged before retrying.

---

[API](https://skmtc.dev/diffchecker/apis/diffchecker-api.md) · [All operations](https://skmtc.dev/diffchecker/apis/diffchecker-api/llms.txt) · [OpenAPI document](https://skmtc.dev/diffchecker/apis/diffchecker-api/revisions/f2bb895fe9a7?raw)