PlatformWho It's ForAppsSecurityVisionGet Early Access
Home/Platform/API Docs
Platform

API Documentation

Everything you need to integrate MedLync into your application — well-documented, versioned, and developer-friendly.

RESTful APIs. Real-time webhooks. Full FHIR.

The MedLync API exposes all platform capabilities — identity verification, record exchange, medication management, claims processing, and analytics — through a clean, versioned REST interface aligned with HL7 FHIR R4.

Comprehensive reference documentation, interactive API explorers, code samples in multiple languages, and a developer sandbox environment make integration fast and predictable.

REST + FHIRDual interface — simple REST & standards-based FHIR
v1 StableVersioned APIs with long-term support commitments
WebhooksReal-time event delivery for clinical workflows
SDKsOfficial SDKs for JavaScript, Python, Java, and Dart

Everything exposed through clean, consistent APIs

🆔

Identity API

Verify patient identities, create health IDs, look up records, and manage biometric enrollments via simple REST calls.

🔄

Exchange API

Read and write FHIR resources — Patient, Observation, Condition, Encounter, MedicationRequest — across the health network.

💊

Prescriptions API

Create, verify, dispense, and track prescriptions with full audit trail and pharmacist verification workflows.

🚨

Emergency API

Pull emergency health profiles by patient ID or QR code — optimised for speed with sub-100ms response times.

📊

Analytics API

Query aggregated, anonymised population health metrics for reporting, planning, and research applications.

🔔

Webhooks & Events

Subscribe to clinical events — new lab results, admission notifications, prescription fills — delivered to your endpoint in real time.

Built with developers in mind

🖥️

Interactive Explorer

Try every endpoint directly from the docs with your sandbox API keys — no Postman setup required.

📝

Code Samples

Copy-paste ready examples in JavaScript, Python, Java, and Dart covering the most common integration patterns.

📋

Changelog & Versioning

Every API change is documented in a detailed changelog. Breaking changes are versioned and deprecated with 12-month notice.

💬

Developer Support

Dedicated developer Slack community, GitHub issue tracker, and response SLAs for integration questions.

Ready to start building?

Get your sandbox API keys and start integrating MedLync into your application today.

Get API Access