Introduction
Circadify is a platform for measuring vital signs from a standard device camera. The SDK guides the scan, prepares a secure measurement payload, and returns vital signs through the Circadify API.
What You Can Measure
Section titled “What You Can Measure”A single 30-second scan from a smartphone or laptop camera returns:
| Vital Sign | Unit | Description |
|---|---|---|
| Heart Rate | BPM | Pulse rate |
| Heart Rate Variability | ms | Heart rate variability |
| Respiratory Rate | breaths/min | Breathing rate |
| Blood Oxygen (SpO2) | % | Blood oxygen saturation |
| Systolic Blood Pressure | mmHg | Systolic blood pressure |
| Diastolic Blood Pressure | mmHg | Diastolic blood pressure |
Each result includes a confidence score (0–1) indicating measurement reliability.
How It Works
Section titled “How It Works”-
Local capture — The SDK opens the camera with permission, guides scan quality, and prepares the measurement locally. Raw camera frames never leave the device.
-
Secure upload — The SDK uploads a measurement payload for processing. No photos, video, or raw frames are transmitted.
-
Cloud processing — Circadify processes the measurement and returns vital signs.
-
Results returned — Vital signs with confidence scores are returned to your application. No health data is stored by Circadify by default.
Integration Options
Section titled “Integration Options”- Web SDK (
@circadify/web-sdk) — Headless JavaScript/TypeScript library for browser-based measurement flows. Works in Chrome 80+, Firefox 75+, Safari 14+, and Edge 80+. - iOS SDK (
CircadifySDK) — Native Swift package for iOS 15+ apps. Distributed via Swift Package Manager. - Android SDK (
com.circadify:circadify-android-sdk) — Native Kotlin SDK for Android apps. - REST API — Server-side endpoints for session management, result retrieval, and account operations. Authenticate with API keys.
- React components — Pre-built
CircadifyProviderandCircadifyScancomponents with hooks. - Embed Widget — Drop-in
<script>tag that adds a floating or inline scanner to any page. No build step required. - Headless mode — Full SDK capabilities without any UI, for custom implementations.
Developer Portal
Section titled “Developer Portal”Create your account and manage everything at developer.circadify.com:
- Create and revoke API keys
- Test a scan locally with the SDK
- Manage billing and upgrade plans
Next Steps
Section titled “Next Steps”- Quick Start — Create an account, get a key, and run your first scan
- Authentication — API key types, usage, and security
- Web SDK Installation — Install and configure the browser SDK
- REST API Overview — Server-side endpoints and authentication