Skip to main content

Health Check

This endpoint verifies that the NRS service is running correctly.

Endpoint​

GET /api/v1/health/nrs

Headers​

Content-Type:application/json

x-client-key:ck_live_avetium_456

Example Request​

curl -X GET \
  curl --location '{{baseurl}}/api/v1/health/nrs'
  -H "accept: application/json"

Success Response​

{
  "status": "healthy",
  "nrs": {
    "status_code": 200,
    "headers": {
      "date": "Wed, 10 Jun 2026 12:28:10 GMT",
      "content-type": "application/json; charset=utf-8",
      "transfer-encoding": "chunked",
      "connection": "keep-alive",
      "x-frame-options": "DENY",
      "x-request-id": "41183c4b-14b3-4eeb-a3b2-8649ac631f97",
      "set-cookie": "session_id=session_value; Path=/; Domain=localhost; Max-Age=3600; HttpOnly; Secure, __cf_bm=XvWmAcdz2NzXzCXJflRXF12K6SqIKfsXQ0HlMBs3tNQ-1781094489.7899218-1.0.1.1-J6He4rzchXzf2ai.vY6nQlxBdHMDDEFWDGtr4NOnhfyWP_h1nSkzmwZysJeRvdUDJGlWRelG9_6Iz7MKOFQNnbl75ne81t4JjAbCWKdn0YTPBQnMkTHFVQnwYwYFmXhN; HttpOnly; SameSite=None; Secure; Path=/; Domain=ondigitalocean.app; Expires=Wed, 10 Jun 2026 12:58:10 GMT",
      "x-do-app-origin": "d987101e-98d6-4cbc-9a0b-d14c0ae3d169",
      "cache-control": "private",
      "x-do-orig-status": "200",
      "server": "cloudflare",
      "cf-cache-status": "BYPASS",
      "content-encoding": "gzip",
      "cf-ray": "a0985fd12967947b-LHR",
      "alt-svc": "h3=\":443\"; ma=86400"
    },
    "body": {
      "code": 200,
      "data": {
        "ok": true,
        "item": {
          "dummy_test_invoice_notification_sent": true,
          "health_check_completed": true,
          "new_setup": false
        }
      }
    }
  }
}