Developer Resources

API Documentation

Build secure, HIPAA-compliant healthcare applications with MediVault™'s RESTful API. Full support for ZK proofs, FHE computation, and blockchain verification.

Quick Start

1. Get API Key

Sign up and generate your production API key

2. Install SDK

Choose your language and install our SDK

3. Authenticate

Configure OAuth 2.0 and ZK proof verification

4. Start Building

Make your first API call in minutes

API Explorer

Available Endpoints

GET/api/v1/patients/:id

Retrieve patient demographic and medical record metadata

OAuth 2.0 + API Key
POST/api/v1/records

Upload encrypted medical record with automatic AI analysis

OAuth 2.0 + API Key
GET/api/v1/records/:id

Retrieve encrypted medical record with time-limited decryption key

OAuth 2.0 + ZK Proof
POST/api/v1/access-requests

Request provider access to patient records with blockchain audit

OAuth 2.0 + Provider Credential
GET/api/v1/analytics

Query anonymized research data using FHE computation

API Key + Research License

Request Example

// Install SDK
npm install @medivault/sdk

// Initialize client
import { MediVault } from '@medivault/sdk';

const client = new MediVault({
  apiKey: process.env.MEDIVAULT_API_KEY,
  environment: 'production'
});

// Upload encrypted medical record
const record = await client.records.create({
  patientId: 'patient_123',
  file: fileBuffer,
  metadata: {
    type: 'lab_result',
    date: '2025-12-16',
    provider: 'Dr. Sarah Chen'
  },
  encryption: {
    algorithm: 'AES-256-GCM',
    zkProof: true
  }
});

console.log('Record uploaded:', record.id);
console.log('AI Analysis:', record.aiInsights);

Authentication & Best Practices

OAuth 2.0 + API Keys

All API requests require both OAuth 2.0 bearer token and API key for maximum security.

OAuth 2.0 for user authentication
API keys for application identification
ZK proofs for privacy-preserving access
Automatic key rotation every 90 days

Rate Limiting

Fair usage limits ensure platform stability and performance for all users.

Free Tier100 req/hour
Pro Tier1,000 req/hour
EnterpriseCustom limits

Download SDKs

JavaScript

Node.js 18+

Python

Python 3.9+

Java

Java 11+

Ruby

Ruby 3.0+