API Specifications
The technical API specifications for NHCX, published as a Swagger UI.
The official NHCX API specifications are published as a live Swagger UI on the sandbox portal.
Content will be added soon
This page is a placeholder. We will add a structured API specification reference soon. Until then, use the official Swagger UI.
Open the official specifications here: NHCX API Specifications (Swagger UI).
What is planned
- A structured reference for each NHCX protocol API
- Request and response schemas
- Header requirements and examples
For request collections that you can run now, see the Use Case APIs.
Sources
- NHCX-Website_DocumentDetails.xlsx (NHCX sandbox portal, entry 23)