Test API Key

You can verify that your API key is valid and correctly configured by making a request to the authentication test endpoint. This endpoint does not send any messages and can be safely used during development or troubleshooting.

POST/GET /auth/test

Example Request

Use the following curl command to test your API key:

curl --location 'https://<hostname>/auth/test' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Replace YOUR_API_KEY with the API key you wish to test.

All endpoints shown in this documentation use a sample base URL. The production API endpoint is provided by our team upon request.

Response

If the API key is valid, the API will respond with an HTTP 200 OK status code.

HTTP/1.1 200 OK

A successful response confirms that:

• The API key is valid

• Authorization is working correctly

• The key has access to the Mobivate API

If the API key is invalid, expired, or lacks the required permissions, an appropriate 4xx error response will be returned with a JSON-formatted error message.