Endpoints
Every v4 endpoint, what it returns on success, and the v3 call it replaces.
| Method and path | What it does | Success | Replaces in v3 |
|---|---|---|---|
POST /v4/eligibility-checks | Start an eligibility check | 201 | POST /create-task |
GET /v4/eligibility-checks/{id} | Get one check, its status and result | 200 | GET /eligibility-result/{task_id} and GET /task-status/{task_id} |
GET /v4/eligibility-checks | List and search your checks | 200 | GET /get-eligibility-results and GET /universal-search |
POST /v4/eligibility-checks/{id}/cancellation | Cancel a check at the payer | 202 | POST /v2/eligibilities-v2/cancel-eligibility |
POST /v4/appointment-checks | Start a check for a booked appointment | 201, or 200 if a recent result is reused | POST /appointment-create-task |
GET /v4/doctors | Doctors set up for your clinic | 200 | GET /doctors-mapping |
GET /v4/health | Is the API up (no headers needed) | 200 | GET /health |
v3 paths are under /v2/api-integration-v3 unless shown in full.
GET /v4/health answers {"status": "healthy", "timestamp": "..."}. Its timestamp is the
server's local time with no offset, not UTC. It only tells you the API is answering; it does not
check anything behind it.