QR Code Types

Our API supports 10 different types of QR codes, each designed for specific use cases. Before creating a QR code, you need to understand the available types and their input requirements.

Available QR Code Types

Type	Description	Use Case
Website	Redirects to a specific URL	Link to websites, landing pages
File	Downloads files or documents	Share PDFs, images, documents
PDF	Displays PDF documents	Show reports, brochures, forms
Menu	Digital restaurant menus	Food service businesses
Social Links	Multiple social media profiles	Social media marketing
Business Card	Digital business cards	Professional networking
Landing Page	Custom landing pages	Marketing campaigns
WhatsApp	Direct WhatsApp messaging	Customer communication
App Store	App store links	Mobile app promotion
Deep Link	Mobile app deep links	App navigation

Retrieving QR Code Types

To get a list of all available QR code types, make a GET request to the /qr-typologies endpoint:

bash

curl 'https://api.v2.qrcodekit.com/api/qr-typologies?pagination=false' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Account-Id: YOUR_ACCOUNT_ID' \
  -H 'Accept: application/json'

Response

JSON

{
  "@context": "/api/contexts/QrTypology",
  "@id": "/api/qr-typologies",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/api/qr-typologies/0598466c-025c-11ef-83ba-06c4e69992ab",
      "@type": "QrTypology",
      "publicName": "Website",
      "internalName": "website",
      "hasTheme": false,
      "defaultDesign": "/api/qr-designs/92e0d784-11f6-11ef-a394-aa6b8ddf7308"
    },
    {
      "@id": "/api/qr-typologies/0598466c-025c-11ef-83ba-06c4e69992ac",
      "@type": "QrTypology", 
      "publicName": "Business Card",
      "internalName": "business_card",
      "hasTheme": true,
      "defaultTheme": "/api/themes/businesscard1",
      "defaultDesign": "/api/qr-designs/92e0d784-11f6-11ef-a394-aa6b8ddf7308"
    }
  ]
}

Understanding Typology Properties

Each QR code type has the following properties:

Property	Type	Description
`publicName`	string	Human-readable name for the QR code type
`internalName`	string	Internal identifier used by the system
`hasTheme`	boolean	Whether this type supports custom themes
`defaultDesign`	string	Reference to the default QR code design
`defaultTheme`	string	Reference to the default theme (if applicable)

Using Typologies in QR Creation

When creating a QR code, you'll need to reference the typology by its @id value. For example, to create a Website QR code, you would use:

JSON

{
  "typology": "/api/qr-typologies/0598466c-025c-11ef-83ba-06c4e69992ab",
  "input": {
    "url": "https://example.com"
  },
  "title": "My Website QR"
}

Next Steps

Now that you understand the available QR code types, you can: