Health check
Overview
Health Check
Check the health and status of the Background Check API service
GET
Health check
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
Example Response
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
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.

