Quick Start

This guide walks you through signing up, creating an API key, and choosing the SDK that fits your stack.

Prerequisites

• A Circadify developer account (free, approved within 24 hours)
• HTTPS for any page that opens the camera (localhost works for development)

Create Your Account

1. Sign up at developer.circadify.com

   Fill in your name, work email, company, and category. Your account will be submitted for review.

2. Wait for approval

   Our team reviews new accounts and you’ll receive an email when approved. This typically takes less than 24 hours.

3. Log in at developer.circadify.com/login

   Once approved, log in with your email and password to access the developer dashboard.

Create an API Key

1. Navigate to the Keys page in the dashboard sidebar.

2. Click Create Key.

3. Enter a name (e.g., “Development” or “Production”).

4. Copy your key immediately. It’s only shown once. You’ll see the key in this format:

   ck_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4

Caution

Your full API key is displayed only once at creation time. After that, only the prefix is visible in the dashboard. Store it securely — if you lose it, you’ll need to create a new one.

Pick an SDK

Each SDK is downloadable from the SDKs page in the developer portal. Choose the one that matches your stack — the linked guide takes you through installation and your first scan.

React SDK @circadify/react — provider, hooks, and a styled component for React 18+.

Web SDK @circadify/web-sdk — headless TypeScript SDK for vanilla JS, Vue, Svelte, or any framework with a build step.

iOS SDK Native Swift package for iOS apps — same extraction pipeline, native AVFoundation camera handling.

Embed Widget One