Error
A valid request URL is required to generate request examples{}Overview
Health Check
Check the health and status of the Background Check API service
GET
/
health
Error
A valid request URL is required to generate request examples{}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
boolean
Always returns
true when the service is healthystring
Current service version or image identifier
Example Request
curl -sS -i "https://sandbox.theary.ai/health"
const response = await fetch('https://sandbox.theary.ai/health')
const healthStatus = await response.json()
console.log('Service Status:', healthStatus)
import requests
response = requests.get('https://sandbox.theary.ai/health')
health_status = response.json()
print('Service Status:', health_status)
Example Response
{
"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 |
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.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
200 - application/json
Health check successful
The response is of type object.