> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-en/sdks/backend-sdk/ocr/technical_documentation/api_reference/management/api-v1-health.md).

# /api/v1/health

Checks whether the service is active.

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"servers":[{"url":"http://127.0.0.1:6982/"}],"security":[],"paths":{"/api/v1/health":{"get":{"description":"Checks whether the service is active.","tags":["Management"],"responses":{"200":{"description":"A message with the health status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResult"}}}},"400":{"description":"Incorrect parameters were received in the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResult"}}}},"500":{"description":"An error occurred in the call to the OCR-SDK backend.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResult"}}}}}}}},"components":{"schemas":{"HealthResult":{"type":"object","description":"The result of a health check.","properties":{"message":{"$ref":"#/components/schemas/HealthStatus"}}},"HealthStatus":{"type":"string","description":"Result of the service health status (whether the SDK is active or not).","enum":["Healthy","No healthy"]},"BadRequestResult":{"type":"object","description":"Result when incorrect parameters are received in the request.","properties":{"status":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"A date/time value in format \"%Y-%m-%dT%H:%M:%SZ\"."},"ExceptionResult":{"type":"object","description":"An error occurred in the call to the OCR-SDK backend.","properties":{"status":{"type":"number"},"error":{"type":"string"},"exception":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}}}}}
```