> ## Documentation Index
> Fetch the complete documentation index at: https://broker-docs.newyorkcityservers.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Verify API Access

> Choose the correct authentication check and verify an integration before using service endpoints.

Use the two `/v1/auth-check` operations to confirm that an integration can reach the API with the permissions it needs. These checks do not create or change service records.

## Which Check To Use

| Operation             | Use it to verify                                                                     | Required scope                   |
| --------------------- | ------------------------------------------------------------------------------------ | -------------------------------- |
| `GET /v1/auth-check`  | The API key, network path, IP Firewall, rate limit, and general authentication work. | No feature scope                 |
| `POST /v1/auth-check` | The key can create services through endpoints that require service-write access.     | `services:write` or `admin:full` |

Most integrations should start with `GET /v1/auth-check`. Run `POST /v1/auth-check` only when the integration creates services.

## Recommended Verification Sequence

1. Create an API key with the scopes the integration needs.
2. Configure the [IP Firewall](/api/firewall) for the system's outbound IP address when IP restriction is enabled.
3. Send `GET /v1/auth-check` from the same system and network path that will call the API.
4. Send `POST /v1/auth-check` if the integration will create services.
5. Continue to the required service, request, or report endpoint after the checks succeed.

## Check Authentication

`GET /v1/auth-check` verifies the key without requiring a feature scope. A successful response returns broker, key, and permission details.

[Open The Authentication Check Reference](/api/auth-check)

Use this operation first when diagnosing HTTP `401`, `403`, or `429` responses. It tests the same key, firewall, and rate-limit controls used by the other public API operations.

## Check Service Write Access

`POST /v1/auth-check` verifies that the key has `services:write` or `admin:full`. It does not create a service.

[Open The Service Write Access Reference](/api/auth-check-write-access)

A successful general authentication check does not guarantee service-write access. If this check returns HTTP `403`, add the required scope or use a different key.

Read [Authentication](/api/authentication) for key formats, scope rules, and authentication errors.