Authentication

All requests to the Aniva Partner API must include your partner API key in the x-api-key request header.

x-api-key: your-api-key-here

Contact Aniva to obtain your API key. Keys are issued per partner account.

Sending authenticated requests

Include the x-api-key header in every request you make to the API.

curl https://anivahealth.com/api/v1/locations \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch('https://anivahealth.com/api/v1/locations', {
  headers: {
    'x-api-key': 'YOUR_API_KEY',
  },
});

const data = await response.json();

Error responses

If your request has no x-api-key header, the API responds with 401 Unauthorized.

{
  "error": "This endpoint requires API key authentication"
}

If the API key is not valid, the API responds with 401 Unauthorized.

{
  "error": "Invalid API key"
}

If the key is valid but does not have the scope for the endpoint, the API responds with 403 Forbidden.

{
  "error": "Insufficient permissions: requires test_sessions_schedule scope"
}

If you receive one of these errors, verify that:

Your request includes the x-api-key header.
The API key value is correct and has not been rotated.
Your key has the scope that the endpoint requires. Each endpoint in the API reference names its scope.

Never expose your API key in client-side code or public repositories. Treat it like a password.

Contact Aniva to rotate a compromised key or to request changes to your API key permissions.

Get Started

Core Concepts

Guides

Sending authenticated requests

Error responses

​Sending authenticated requests

​Error responses

Sending authenticated requests

Error responses