Web, iOS, Android, embed, headless, and REST integrations. One session model, the integration shape your product needs.
Build contactless vital sign workflows with Web (including React), native mobile, embed widget, headless SDK, or REST integrations. SDKs manage camera access, scan guidance, payload preparation, secure upload, polling, and cleanup.
import { CircadifySDK } from '@circadify/web-sdk';
const sdk = new CircadifySDK({
apiKey: 'ck_live_your_key_here',
onProgress: (event) => updateProgress(event.percent),
onQualityWarning: (warning) => showHint(warning.message),
onQualityState: (state) => updateQualityMeters(state),
});
const result = await sdk.measureVitals({
videoElement: document.getElementById('preview-video'),
demographics: { age: 35, sex: 'M', fitzpatrick: 3 },
});Each path uses the same core session model while giving your team the right UI control, platform support, and deployment shape.
@circadify/web-sdkHeadless JavaScript and TypeScript SDK for vanilla JS, Vue, Svelte, or any browser app — bundled with prebuilt React components (provider, hooks, a styled CircadifyScan) to speed up implementation.
npm install @circadify/web-sdkCircadifySDKNative Swift package for iOS apps with camera permissions, measurement options, callbacks, and result retrieval.
Swift Package Managercom.circadify:circadify-android-sdkNative Kotlin SDK for Android apps using CameraX, quality callbacks, cancellation, secure upload, and result polling.
implementation("com.circadify:circadify-android-sdk:0.1.1")https://api.circadify.comServer-side endpoints for session creation, secure payload upload completion, result retrieval, account operations, and usage.
X-API-Key: ck_live_your_key_heremeasureVitals({ videoElement })Use SDK capture, scan-quality callbacks, secure upload, and polling while rendering your own camera and results interface.
Use your own preview, overlays, and result UIThe SDK performs local capture, scan quality checks, and measurement payload preparation before secure processing. The low-level payload format is private and can change between SDK versions.
The SDK opens the camera with permission, guides scan readiness, and checks lighting, motion, pose, and face position.
The SDK prepares a secure measurement payload locally. The standard flow does not upload raw video, raw frames, or photos.
The SDK uploads the prepared payload and Circadify returns configured vital sign outputs through the API.
Your app receives structured results with confidence context. Circadify does not retain results by default.
BPM result with confidence context.
Returned as supported HRV metrics for the scan.
Breaths per minute when scan quality is sufficient.
Systolic and diastolic trend outputs when enabled.
Blood oxygen signal when enabled for the deployment.
Derived signals when supported by the configuration.
import { CircadifySDK } from '@circadify/web-sdk';
const sdk = new CircadifySDK({
apiKey: 'ck_live_your_key_here',
onProgress: (event) => updateProgress(event.percent),
onQualityWarning: (warning) => showHint(warning.message),
onQualityState: (state) => updateQualityMeters(state),
});
const result = await sdk.measureVitals({
videoElement: document.getElementById('preview-video'),
demographics: { age: 35, sex: 'M', fitzpatrick: 3 },
});import { CircadifyProvider, CircadifyScan } from '@circadify/web-sdk/react';
import '@circadify/web-sdk/react/styles.css';
export function ScanPage() {
return (
<CircadifyProvider apiKey="ck_live_your_key_here">
<CircadifyScan
type="standard"
onResult={(result) => saveResult(result)}
onError={(error) => showRetry(error.message)}
/>
</CircadifyProvider>
);
}curl -X POST https://api.circadify.com/sdk/session/start \
-H "X-API-Key: ck_live_your_key_here" \
-H "Content-Type: application/json"
curl -X PUT "$UPLOAD_URL" \
-H "Content-Type: application/octet-stream" \
--data-binary @measurement-payload.bin
curl https://api.circadify.com/sdk/session/$SESSION_ID/result \
-H "X-API-Key: ck_live_your_key_here"Start with docs, request API access, or talk through the right SDK path for your product and deployment requirements.
See how contactless vitals can transform your healthcare delivery.