Overview
The health check endpoint verifies connectivity to the SIFEN service by performing a lightweight RUC consultation. This endpoint is essential for monitoring, alerting systems, and readiness checks.Endpoint
Path Parameters
Target environment for health check
prod- Production SIFEN environmenttest- Test SIFEN environment
Query Parameters
Optional taxpayer RUC for environment-specific health checks. If not provided, a random test RUC is used.
Response
Success Response (UP)
Returns HTTP 200 when SIFEN service is reachable and responding normally.Service status:
UP or DOWNEnvironment checked (
prod or test)HTTP status code from SIFEN service response
ISO 8601 timestamp of the health check
Failure Response (DOWN)
Returns HTTP 503 when SIFEN service is unreachable or experiencing issues.Status Codes
| Code | Status | Description |
|---|---|---|
| 200 | UP | SIFEN service is healthy and responding |
| 503 | DOWN | SIFEN service is unavailable or not responding properly |
Examples
Check Production Environment
Check Test Environment
Check with Specific Emisor
Use Cases
1. Kubernetes Readiness Probe
2. Monitoring Dashboard
Use this endpoint to track SIFEN uptime across environments:3. Pre-flight Validation
Before processing critical operations, verify SIFEN availability:Health Check Logic
The endpoint performs a lightweight RUC consultation to verify SIFEN connectivity:- Generates a random test RUC (or uses provided
emisor) - Performs RUC query against SIFEN service
- Evaluates HTTP response code:
- UP: HTTP status 200-499 (service responding)
- DOWN: HTTP status 500+ or network failure