Health Check

Check API health status (no authentication required)

Endpoint: GET https://api.uncash.io/api/v1/health

Notes

This endpoint does not require authentication and can be used to verify API availability.

Response

Success Response

Field	Type	Description
success	boolean	Indicates if the API is healthy
message	string	Success message

Data Object

Field	Type	Description
status	string	Health status (e.g., "healthy")
environment	string	Deployment environment
timestamp	string	ISO 8601 timestamp
uptime	number	Server uptime in milliseconds

Request Example

cURL

curl -X GET https://api.uncash.io/api/v1/health

JavaScript

const response = await fetch('https://api.uncash.io/api/v1/health');
const data = await response.json();

Python

import requests

url = "https://api.uncash.io/api/v1/health"
response = requests.get(url)
data = response.json()

Response Example

{
  "success": true,
  "data": {
    "status": "healthy",
    "environment": "production",
    "timestamp": "2025-08-03T10:00:00.000Z",
    "uptime": 1722686400000
  },
  "message": "API is healthy"
}

Additional Information

Monitoring: Use this endpoint for health checks, monitoring, and load balancer status verification. It provides a quick way to verify API availability.