Data Flow

How data moves through Circadify from camera capture to vital signs results.

This page describes the public measurement flow at an integration level. It intentionally avoids low-level SDK implementation details and payload formats.

End-to-End Flow

Session creation - Your app or SDK creates a measurement session with the Circadify API.
Local capture - The SDK opens the camera with user permission and performs local capture and quality checks.
Secure upload - The SDK uploads a prepared measurement payload over TLS. Raw camera video and raw frames are not uploaded.
Cloud processing - Circadify processes the uploaded payload and computes the requested vital signs.
Result delivery - The result is returned to your application. Your application decides whether to store it.

With an SDK

SDK integrations should use the SDK's single measurement method. For Android this is measureVitals(options):

val result = sdk.measureVitals(
    MeasurementOptions(
        lifecycleOwner = lifecycleOwner,
        previewView = previewView,
        demographics = Demographics(age = 35, sex = Sex.M, fitzpatrick = 3),
    ),
)

kotlin

The SDK reports progress through the measurement lifecycle:

Phase	What it means
`INITIALIZING`	Creating a session and preparing capture
`READINESS`	Waiting for camera and quality conditions
`CAPTURING`	Capturing the measurement
`UPLOADING`	Uploading the measurement payload
`PROCESSING`	Waiting for cloud processing to complete

Without an SDK

The REST API is available for approved integrations. The supported public endpoints are:

Method	Path	Purpose
`POST`	`/sdk/session/start`	Create a measurement session
`POST`	`/sdk/session/upload-complete`	Notify that upload is complete and start processing
`GET`	`/sdk/session/{sessionId}/result`	Retrieve results for async workflows

Custom integrations are responsible for producing a compatible upload payload. That format is not documented publicly. Contact support@circadify.com if your integration requires direct upload access.

Caution

Use the SDK unless Circadify has explicitly approved a custom integration path for your account.

Data Handling

Data	Handling
Raw video / camera frames	Stay on the user's device
Measurement payload	Uploaded securely for processing and discarded after processing
Vital sign results	Returned to your app; not retained by Circadify by default
Usage record	Retained for billing, quota, and audit purposes

Next Steps

Android SDK - Install the native Kotlin SDK
Web SDK - Install the browser SDK
REST API Overview - Public endpoint reference
Data Handling - Collection and retention details