Request Body — Fields
Required fields| Field | Type | Description |
|---|---|---|
category | integer | QR Code category ID. See Category List for IDs. |
info | string | JSON string containing QR Code component data (see Components Reference). |
name | string | Human-readable name for the QR Code. |
qr_type | string | QR type. Use dy for Dynamic QR Codes (fixed). |
Note: Advanced features (custom domains, geo-fencing, lead capture, expiry) may require specific plan quotas or entitlements.
| Field | Type | Description |
|---|---|---|
pattern_info | object or string | (Optional) Design customization (pattern, colors, eyes, frame, errorCorrection). See Pattern Info Reference. Some clients require this serialized as a JSON string. |
custom_domain | integer | Custom domain ID (advanced plan feature). |
expire_on | string (date-time) | Expiration timestamp (requires plan quota). |
expire_on_text | string (HTML) | HTML content to show when QR is expired. |
expire_on_timezone | string | Timezone for expiry (e.g., Asia/Kolkata). |
high_accuracy_confirmation | boolean | High-accuracy confirmation for location QR codes. |
high_accuracy_geo_fencing | boolean | Enable geo-fencing (requires plan quota). |
high_accuracy_geo_fencing_config | object | Geo-fencing config (displayText, fallback, mapLocation, range, unit, redirectUrl). |
high_accuracy_mode | boolean | Request location access behavior toggle. |
high_accuracy_mode_text | string | Text shown when requesting location permission. |
lead_list | integer | Lead list ID to capture leads. |
minimum_age | integer | Minimum age required to access content. |
password | string | Password to protect QR Code content. |
Authorizations
API key authentication. Enter your API key directly in the Authorization header.
Body
QR Code Category ID. See Category List for available categories.
1
JSON data to create QR code. See Components Reference for detailed structure examples for each category.
"{\"type\":\"url\",\"data\":{\"url\":\"https://example.com\"}}"
Name of the QR Code
"My Website QR Code"
QR code type - 'dy' for Dynamic QR Code
"dy"
JSON data to create design QR Code (optional). See Pattern Info Reference for complete customization options and field values.
"{\"dataInfo\":{\"pattern\":\"lightSquare\",\"gradientStyle\":\"Diagonal\",\"startColor\":\"#000\",\"endColor\":\"#000\",\"logo\":null},\"backGroundColor\":\"#ffffff\",\"eyeInfo\":{\"TL\":{\"innerEyeColor\":\"#000\",\"outerEyeColor\":\"#000\",\"shape\":\"Shape4\"},\"TR\":{\"innerEyeColor\":\"#000\",\"outerEyeColor\":\"#000\",\"shape\":\"Shape4\"},\"BL\":{\"innerEyeColor\":\"#000\",\"outerEyeColor\":\"#000\",\"shape\":\"Shape4\"}},\"version\":\"1.5\",\"type\":\"qrcode\",\"frame\":{\"id\":2,\"primaryColor\":\"#FF7C7C\",\"secondaryColor\":null,\"textColor\":\"#FFFFFF\",\"bgColor\":\"#FFFFFF\",\"category\":\"url\"},\"errorCorrection\":\"Q\"}"
Custom domain ID for the QR code (advanced feature - requires plan quota)
1903
Expiration date and time for the QR code (advanced feature - requires plan quota)
"2025-10-31T02:03:00+05:30"
Custom HTML text to display when QR code is expired (advanced feature - requires plan quota)
"<div style=\"text-align:center\"><img alt=\"\" src=\"https://qcg-media.scanova.io/assets/landing/qr-placeholder-expired.png\" style=\"height:137px; width:150px\" /></div><p style=\"text-align:center\">This QR Code has been deactivated</p>"
Timezone for expiration date (advanced feature - requires plan quota)
"Asia/Kolkata"
Enable high accuracy confirmation for location-based QR codes (advanced feature - requires plan quota)
true
Enable high accuracy geo-fencing for location-based QR codes (advanced feature - requires plan quota)
true
Configuration for high accuracy geo-fencing (advanced feature - requires plan quota)
Enable high accuracy mode for location-based QR codes (advanced feature - requires plan quota)
true
Text to display when requesting location access (advanced feature - requires plan quota)
"The QR Code administrator is requesting one-time access to your device's location. You will be redirected to the content regardless of your choice."
Lead list ID for capturing leads (advanced feature - requires plan quota)
1106
Minimum age requirement for accessing QR code content (advanced feature - requires plan quota)
18
Password protection for QR code access (advanced feature - requires plan quota)
"123456"
Response
QR Code created successfully
Internal QR code ID
2411719
Unique QR code identifier
"Q3493df1c0e074ac7"
Name of the QR code
"QR Code"
QR code type
"dy"
Human-readable QR code type
"Dynamic"
JSON data for QR code content
"{\"type\":\"url\",\"data\":{\"url\":\"https://scanova.io\"}}"
QR code design pattern information
null
SVG code for QR code
null
Thumbnail URL for QR code
null
Whether the QR code is active
true
QR code version
1
Creation timestamp
"2025-10-24T18:54:22.697338+05:30"
Last modification timestamp
"2025-10-24T18:54:22.697362+05:30"
List of tags associated with QR code
[]Whether the QR code is password protected
false
Whether the QR code has age restrictions
false
Whether the QR code uses designer features
false
Pattern type for QR code design
null
User who created the QR code
null
Password for QR code access
null
AI-generated QR code information
null
Wallet pass information
null
Whether the QR code is scannable
null
Number of custom form responses
0
Number of RSVP form responses
0
Number of restaurant feedback responses
0