> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.theary.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Health Check

> Check the health and status of the Background Check API service

# Health Check

Simple endpoint to verify that the Background Check API service is running and accessible. This endpoint does not require authentication.

## Authentication

**None required** - This is a public endpoint for service monitoring.

## Response

<ResponseField name="success" type="boolean">
  Always returns `true` when the service is healthy
</ResponseField>

<ResponseField name="image" type="string">
  Current service version or image identifier
</ResponseField>

## Example Request

<CodeGroup>
  ```bash cURL theme={null}
  curl -sS -i "https://sandbox.theary.ai/health"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://sandbox.theary.ai/health')
  const healthStatus = await response.json()
  console.log('Service Status:', healthStatus)
  ```

  ```python Python theme={null}
  import requests

  response = requests.get('https://sandbox.theary.ai/health')
  health_status = response.json()
  print('Service Status:', health_status)
  ```
</CodeGroup>

## Example Response

```json theme={null}
{
  "success": true,
  "image": "api:stable"
}
```

## Use Cases

* **Service Monitoring**: Check if the API is operational
* **Load Balancer Health Checks**: Automated health monitoring
* **Integration Testing**: Verify connectivity before making authenticated requests
* **Troubleshooting**: First step in diagnosing API connectivity issues

## Response Codes

| Status Code | Description                        |
| ----------- | ---------------------------------- |
| `200`       | Service is healthy and operational |

<Note>
  This endpoint always returns 200 when the service is reachable. A non-200 or no response indicates an infrastructure-level issue rather than an application error.
</Note>


## OpenAPI

````yaml GET /health
openapi: 3.0.0
info:
  title: SNH AI Background Check API
  description: >-
    AI-powered agentic background verification service for employment and
    education checks.
  version: '1.0'
  contact: {}
servers:
  - url: https://sandbox.theary.ai
    description: Sandbox
  - url: https://api.theary.ai
    description: Production
  - url: http://localhost:3000
    description: Local development
security:
  - bearerAuth: []
tags: []
paths:
  /health:
    get:
      tags:
        - App
        - Health
      summary: Health check
      operationId: get-health
      parameters: []
      responses:
        '200':
          description: Health check successful
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    bearerAuth:
      scheme: bearer
      bearerFormat: JWT
      type: http

````