Health Check | QwikLive API

GET /api/health

Operation ID: EapiHealthCheck · No request body · No authentication required

💡

No Authentication Required

This endpoint does not require client_id, client_secret, or partnerId. Use it to verify sandbox or production connectivity before starting an integration session.

No request body required for this endpoint.

curl

curl -s https://{sandbox-host}/api/health

status string

Overall status: ok · degraded · down

environment string

Active environment: sandbox · qa · uat · prod

version string

API version string. Example: "v1.0.5"

dependencies[].name string

Dependency name: Gateway · CoreBanking

dependencies[].status string

Dependency status: UP · DEGRADED · DOWN

dependencies[].latencyMs number

Response latency from the dependency in milliseconds.

json — 200 OK (healthy)

{
  "status":      "ok",
  "environment": "sandbox",
  "version":     "v1.0.5",
  "dependencies": [
    { "name": "Gateway", "status": "UP", "latencyMs": 12 },
    { "name": "CoreBanking",  "status": "UP", "latencyMs": 45 }
  ]
}

Degraded Example

json — 200 OK (degraded)

{
  "status":      "degraded",
  "environment": "sandbox",
  "version":     "v1.0.5",
  "dependencies": [
    { "name": "Gateway", "status": "UP",       "latencyMs": 12  },
    { "name": "CoreBanking",  "status": "DEGRADED", "latencyMs": 950 }
  ]
}

Error Responses

HTTP Status	Reason	When
500	`HTTP:INTERNAL_SERVER_ERROR`	Unexpected server failure
503	`HTTP:BAD_CONNECTIVITY`	API unavailable

Usage Notes

Do not use this endpoint as a polling heartbeat — it is intended for session startup verification only.
A degraded status means the API is partially operational. Financial transactions may succeed but may be slower or intermittently fail.
A DOWN dependency status means financial transactions will likely fail. Do not proceed until the dependency returns UP.