Check API health

Use the public health endpoint to verify that the Trust Platform API is operational

The Trust Platform API exposes a public health endpoint that returns the current status of the service. It requires no authentication and is suitable for automated monitoring, alerting pipelines, and manual status checks.

---

Endpoint

GET /api/health

Authentication: None required. This endpoint is publicly accessible without a Bearer token.

---

Response

Response parameters

Parameter	Type	Description
status	string	Health status of the service. "OK" when operational.
timestamp	string	ISO 8601 timestamp of when the health check was evaluated
service	string	Name of the service

{
  "status": "OK",
  "timestamp": "2026-01-01T10:00:00.000Z",
  "service": "trust-platform-api"
}

HTTP status codes

Status	Description
200	Service is healthy
503	Service temporarily unavailable. The response may not include the JSON body shown above. Treat it as the API being unavailable and retry later.

---

Example

curl --request GET https://localhost:3000/api/health

---

Status page

You can also check the operational status of the Trust Platform at the IDnow status page. The page reflects the health of the Trust Platform component and updates automatically.

---