Raw schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "What to encode. 'url', 'text' and 'wifi' work on any plan. 'vcard', 'email', 'phone' and 'sms' require Flyn Pro.",
"enum": [
"url",
"text",
"wifi",
"vcard",
"email",
"phone",
"sms"
]
},
"url": {
"type": "string",
"description": "For type 'url': the URL to encode."
},
"text": {
"type": "string",
"description": "For type 'text': the plain text to show when scanned."
},
"wifiSsid": {
"type": "string",
"description": "For type 'wifi': the network name."
},
"wifiPass": {
"type": "string",
"description": "For type 'wifi': the password. Omit for an open network."
},
"wifiEnc": {
"type": "string",
"description": "For type 'wifi': security type. Defaults to WPA.",
"enum": [
"WPA",
"WEP",
"nopass"
]
},
"wifiHidden": {
"type": "boolean",
"description": "For type 'wifi': true if the network does not broadcast its SSID."
},
"vcName": {
"type": "string",
"description": "For type 'vcard': the person's full name. Required for a v-card."
},
"vcOrg": {
"type": "string",
"description": "For type 'vcard': organisation or company."
},
"vcPhone": {
"type": "string",
"description": "For type 'vcard': phone number. Include the country code, for example +15551234567."
},
"vcEmail": {
"type": "string",
"description": "For type 'vcard': email address."
},
"vcUrl": {
"type": "string",
"description": "For type 'vcard': website URL."
},
"email": {
"type": "string",
"description": "For type 'email': the recipient address."
},
"emailSubject": {
"type": "string",
"description": "For type 'email': pre-filled subject line."
},
"emailBody": {
"type": "string",
"description": "For type 'email': pre-filled message body."
},
"phone": {
"type": "string",
"description": "For type 'phone': the number to dial. Include the country code, for example +15551234567, or the code only works for people dialling from the same country."
},
"smsPhone": {
"type": "string",
"description": "For type 'sms': the number to text. Include the country code."
},
"smsBody": {
"type": "string",
"description": "For type 'sms': the pre-filled message. The sender still has to press send."
},
"format": {
"type": "string",
"description": "Output format: 'png' (default) or 'svg'. SVG requires Flyn Pro.",
"enum": [
"png",
"svg"
]
},
"size": {
"type": "integer",
"description": "Maximum width in pixels, 64 to 2048, default 512. The image is the largest whole-module square that fits, so the real width is usually slightly smaller and is reported back.",
"minimum": 64,
"maximum": 2048
},
"margin": {
"type": "integer",
"description": "Quiet zone in modules. Minimum and default is 4, as required by ISO/IEC 18004; smaller values are raised to 4 because a short quiet zone is the most common cause of a printed code failing to scan.",
"minimum": 4,
"maximum": 32
},
"level": {
"type": "string",
"description": "Error correction level: 'L', 'M' (default), 'Q' or 'H'. Higher levels survive more damage but make the symbol denser.",
"enum": [
"L",
"M",
"Q",
"H"
]
},
"fg": {
"type": "string",
"description": "Foreground colour as 6-digit hex, default Flyn green #14532D. Requires Flyn Pro."
},
"bg": {
"type": "string",
"description": "Background colour as 6-digit hex, default #FFFFFF. Requires Flyn Pro."
}
},
"required": [
"type"
],
"additionalProperties": false
}