Skip to main content
GET
https://api.theary.ai
/
health
Health Check
curl --request GET \
  --url https://api.theary.ai/health \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "image": "<string>"
}

​
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

​
success
boolean
Always returns true when the service is healthy
​
image
string
Current service version or image identifier

​
Example Request

curl -X GET "https://api.theary.ai/health"

​
Example Response

{
  "success": true,
  "image": "verification-api:latest"
}

​
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 CodeDescription
200Service is healthy and operational
500Service is experiencing issues
If you receive any status code other than 200, the service may be experiencing issues. Contact support if problems persist.