Health check · SUMU API Docs

The only unauthenticated endpoint on this API — no X-API-Key needed. Useful as an uptime check, or to confirm which environment you're actually talking to before debugging anything else.

GET/v1/api/health

Wrapped in the same envelope as every other endpoint — see Overview — so a shared response parser doesn't need a special case for this one.

Response fields

Field	Type		Description
version	string	—	API version
peppol_ap_id	string	—	SUMU's Peppol Access Point identifier — scheme 0242 (an Access Point, not a taxpayer's 0248 address) followed by this deployment's seat ID
environment	string	—	Which deploy environment answered — useful for confirming you're not accidentally hitting sandbox
status	string	—	operational is the only value seen in practice; treat anything else, or a non-200, as down
pint_om_version	string	—	Which version of the Oman PINT specification this deployment validates against

REQUEST

cURL

curl https://api.joinsumu.com/v1/api/health

RESPONSE200 OK

application/json

{
"statusCode": 200,
"request_id": "a78010ec-a2bd-41e7-9c0d-654449103c7b",
"timestamp": "2026-08-13T06:52:02.829Z",
"message": "Service is operational",
"data": {
  "version": "1.0.0",
  "peppol_ap_id": "0242:001194",
  "environment": "production",
  "status": "operational",
  "pint_om_version": "1.0.1"
}
}