Health Check

curl --request GET \
  --url https://sandbox.theary.com/health

{
  "success": true,
  "image": "<string>"
}

GET

health

Health Check

curl --request GET \
  --url https://sandbox.theary.com/health

{
  "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.

success

boolean

Always returns true when the service is healthy

image

string

Current service version or image identifier

curl -X GET "https://sandbox.theary.com/health"

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

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

Status Code	Description
`200`	Service is healthy and operational
`500`	Service is experiencing issues

If you receive any status code other than 200, the service may be experiencing issues. Contact support if problems persist.