Skip to content

Quick Start

Get started with Circuit KYC Network in under 5 minutes.

Step 1: Get Your API Key

  1. Sign up at circuit-kyc.com/signup
  2. Complete email verification
  3. Get your sandbox API key from the dashboard

Your sandbox key starts with sk_sandbox_.

Step 2: Install an SDK

pip install circuit-kyc

npm install @circuit-kyc/sdk

No installation needed.

Step 3: Make Your First Request

from circuit_kyc import CircuitClient

client = CircuitClient(api_key="sk_sandbox_your-key")

# Check if a user is eligible for fast-track KYC
result = client.check_eligibility(
    email="user@example.com",
    phone="+14155551234"
)

print(f"Eligible: {result.eligible}")
print(f"KYC Level: {result.kyc_level}")
print(f"Confidence: {result.confidence_score}")

import { CircuitClient } from '@circuit-kyc/sdk';

const client = new CircuitClient({ apiKey: 'sk_sandbox_your-key' });

const result = await client.checkEligibility({
  email: 'user@example.com',
  phone: '+14155551234',
});

console.log('Eligible:', result.eligible);
console.log('KYC Level:', result.kyc_level);
console.log('Confidence:', result.confidence_score);

curl -X POST https://sandbox.circuit-kyc.com/api/v1/check-eligibility \
  -H "X-API-Key: sk_sandbox_your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "phone": "+14155551234"
  }'

What's Next?