New: meet Cleo, the AI that lives inside your QR codes.Meet Cleo, the AI inside your QR codesDiscover Cleo →

Quickstart

Get up and running with the QRCodeKIT API in just a few steps. This guide will help you create your first QR code quickly.

Step 1: Set Up Authentication

Choose your preferred authentication method:

Generate an API key from your dashboard for server-to-server communication

Learn More →

JWT Token

Use JWT tokens for web applications and user-based authentication

Learn More →

Step 2: Understand QR Code Types

Learn about the 10 different types of QR codes you can create:

QR Code Types

Explore Website, Business Card, File, Menu, and other QR code types

Learn More →

Step 3: Create Your First QR Code

Start with a simple Website QR code:

Website QR Guide

Create QR codes that redirect to websites

Learn More →

Quick Example

Here's a minimal example to create a Website QR code:

bash
# 1. Create a Website QR code
curl -X POST 'https://api.v2.qrcodekit.com/api/qrs' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "typology": "/api/qr-typologies/0598466c-025c-11ef-83ba-06c4e69992ab",
    "input": {
      "url": "https://example.com"
    },
    "title": "My First QR Code"
  }'
No X-Account-Id needed with API keysYour API key is bound to a single workspace, so requests authenticated with X-Api-Key don't need the X-Account-Id header. That header is only required with JWT tokens, where one user can belong to several workspaces.

Next Steps

Once you've created your first QR code, explore these features:

Manage QR Codes via API

Retrieve, list, update and delete your QR codes with your API key

Learn More →

Organize with Projects

Group your QR codes into projects for better organization

Learn More →

Advanced Features

Add password protection and visit limits to your QR codes

Learn More →

Bulk Operations

Create and manage multiple QR codes at once

Learn More →

Analytics

Track QR code performance and user engagement

Learn More →

Need Help?

  • API Reference: Explore all available endpoints
  • Authentication Guide: Detailed authentication instructions
  • Error Handling: Learn how to handle common errors
  • Support: Contact our support team for assistance

Two free dynamic QR codes. Yours forever.

No credit card. No expiry. The original dynamic QR platform since 2009.

A dynamic QR code surrounded by the content it can hold