Health & Status

Overview

The health check endpoint provides real-time status information about the eFICA API. This endpoint is useful for monitoring, status checks, and ensuring the API is operational.

Endpoint Details

URL: GET /health
Authentication: Not required (Public endpoint)
Content-Type: application/json

Request

No request body or parameters required.

Example Request

curl -X GET https://sandboxapi.efica.co.za/health

Response

Success Response (200 OK)

{
  "status": "ok",
  "uptime": 12345,
  "timestamp": "2023-01-01T00:00:00.000Z",
  "version": "1.0.0"
}

Response Fields

Field	Type	Description	Example
status	string	Health status of the API	"ok" or "error"
uptime	number	Application uptime in seconds	12345
timestamp	string	Current timestamp in ISO format	"2023-01-01T00:00:00.000Z"
version	string	Application version	"1.0.0"

Error Response (503 Service Unavailable)

{
  "status": "error",
  "message": "Service unavailable",
  "timestamp": "2023-01-01T00:00:00.000Z"
}

Troubleshooting

Common Issues

1. Connection Timeout

   • Check network connectivity
   • Verify the API URL is correct
   • Check firewall settings

2. 503 Service Unavailable

   • API may be under maintenance
   • Check with your account manager
   • Wait and retry

3. Unexpected Response Format

   • Verify you're using the correct API version
   • Check for API updates
   • Contact support if issues persist

Support

If you experience issues with the health endpoint:

1. Check the API status with your account manager
2. Verify your network connectivity
3. Contact support at melissa@efica.co.za

---

Last Updated: 19 August 2025