Documentation

Build with QikCard

Everything you need to integrate QikCard into your events, applications, and workflows. From quick start guides to advanced API references.

Popular Documentation

Most accessed guides and references to get you started quickly.

Popular
Architecture Overview
System architecture and component interactions
Technical
ICP Integration Guide
How QikCard leverages Internet Computer Protocol
Essential
Event Setup Checklist
Step-by-step checklist for event organizers
Support
Troubleshooting Guide
Common issues and their solutions

Complete Documentation

Comprehensive guides, tutorials, and references for all QikCard features.

Getting Started
Quick start guide for developers and event organizers
Hardware Integration
QikPoint scanner and QikCard hardware documentation
Security & Privacy
Security best practices and privacy controls
SDKs & Tools
Development tools and software development kits

Quick Start Example

Get up and running with QikCard in just a few lines of code. Our SDK makes integration simple and straightforward.

1
Install the QikCard SDK
2
Initialize with your API key
3
Create events and scanners
JavaScript SDK
Latest
// Initialize QikCard SDK
import { QikCard } from '@qikcard/sdk';

const qikcard = new QikCard({
  apiKey: 'your-api-key',
  environment: 'production'
});

// Create a new event
const event = await qikcard.events.create({
  name: 'Web3 Developer Conference',
  startDate: '2025-03-15',
  endDate: '2025-03-17',
  location: 'San Francisco, CA'
});

// Set up QikPoint scanners
const scanner = await qikcard.scanners.create({
  eventId: event.id,
  type: 'BoothTag',
  location: 'Main Entrance'
});

console.log('Event created:', event.id);

Need Help?

Our team is here to support you every step of the way.

Documentation

Comprehensive guides and tutorials

Community

Connect with other developers

Support

Direct support from our team