Contract overview
Health Yourself uses the Idunox Platform API to submit de-identified questionnaire and blood marker data as canonical Type A JSON (canonical_submission_v1), track processing, and retrieve completed results with wellbeing outcomes and optional report artefacts.
Map intake data to the canonical shape in your backend before POST /v1/submissions — see Canonical submission JSON. The live contract matches platform baseline tag baseline (OpenAPI synced from iduscore-platform-services).
Base URL
/v1/.
Endpoints
| Method | Path | Purpose |
|---|---|---|
GET | /health | Server health check |
GET | /openapi.json | Machine-readable API contract for SDK generation and API tooling |
GET | /v1/partner-auth-probe | Validate credentials |
POST | /v1/submissions | Submit a de-identified payload for processing |
GET | /v1/submissions/{submissionId} | Poll submission status |
GET | /v1/results/{resultId} | Retrieve a completed result with assessments |
WEBHOOK | Outbound: result.ready | Platform-initiated callback when a result is ready |
Request conventions
Every write request (POST) must include:
x-correlation-idheader — a client-supplied identifier used to trace logs and response payloads.Idempotency-Keyheader — prevents duplicate submissions within a 24-hour window.
Account isolation
All resource IDs are limited to your authenticated . If you request an ID from another account, the API returns404. You cannot access another account’s , , or .
Content type
All requests and responses useapplication/json unless otherwise noted.