ME-QR / API QR code

API QR code

Want to create QR Codes on a large scale? Integrate our QR Code generator API into your business and automate processes. All QR Code types are available for you with Me-QR API.

Generate Your First QR in 10 sec

Generate your first QR code in seconds with a single API request.

Code
curl -X POST https://me-qr.com/api/v2/qr/link/create \
  -H "Content-Type: application/json" \
  -H "X-AUTH-TOKEN: YOUR_API_TOKEN" \
  -d '{
    "qrFieldsData": {
      "link": "https://example.com"
    },
    "format": "png",
    "designType": "base"
  }'
import requests

url = "https://me-qr.com/api/v2/qr/link/create"
headers = {
    "Content-Type": "application/json",
    "X-AUTH-TOKEN": "YOUR_API_TOKEN"
}
payload = {
    "qrFieldsData": {
        "link": "https://example.com"
    },
    "format": "png",
    "designType": "base"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())
const response = await fetch(
  'https://me-qr.com/api/v2/qr/link/create',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-AUTH-TOKEN': 'YOUR_API_TOKEN'
    },
    body: JSON.stringify({
      qrFieldsData: { link: 'https://example.com' },
      format: 'png',
      designType: 'base'
    })
  }
);

const data = await response.json();
console.log(data);

QR Code Preview
QR code example generated via ME-QR API

Authentication & API Keys

Use an API key to authenticate your requests.

Get your API key

Find it in your dashboard:

Dashboard Integrations API keys

Use it in your request

Add your API key to the request header:

Authorization: Bearer YOUR_API_KEY

Usage, Limits & Access

Everything you need to know about API usage, limits, and access.

Usage Pricing

Includes up to 10,000 QR codes per month.

$0.005 / request

Up to 100k requests

$0.0025 / request

100k+ requests

API Access

Free

free

3 API keys · Valid for 3 Days

Premium

Premium

Unlimited API keys · No Expiration

API limits: ~1 request/sec · 50 requests/min (same for all plans)

Contact support to enable additional usage.

QR Code Parameters

Define the content, appearance, and output of your QR codes using available parameters.

Parameter Type Default Description
tokenrequired string API functionality access token
qrType integer 1 QR type: 1=Link, 4=PDF, 5=Email, 7=VCard…
qrFieldsData object [] QR code content depending on the type (e.g. {"link": "https://…"})
title string "Qr Code" QR code title shown in the dashboard
format string "png" Output format: png, svg, jpg, jpeg, json
designType string "base" QR design type: base or art
qrFolderOptions object null Folder placement: {"folderName": "…", "subfolderName": "…"}
entryId integer null ID of existing QR to update instead of creating new

Color & Shape Parameters

Define the content, appearance, and output of your QR codes using available parameters.

Parameter Type Default Description
qrOptions
size integer 300 Size of the returned QR image in px
errorCorrectionLevel string "Q" Error correction: L, M, Q, H
pattern string "square" Dot style: square, dots, rounded, classy, rhombus, spark…
patternColor string "#000000" Color of QR dots
patternBackground string "#ffffff" Background color of QR code
cornetsOuter string "square" Outer corner style: square, dot, classy, gear, extra-rounded…
cornetsOuterColor string "#000000" Color of outer corners
cornetsInterior string "square" Inner corner style: square, dot, classy, rhombus, star…
cornetsInteriorColor string "#000000" Color of inner corners
logotype string null Center logo: predefined enum, URL, or base64 image
logotypeSize number 0.3 Logo size coefficient 0–1 (max recommended 0.5)
logotypeMargin number 0 Logo margin in px
logotypeHideBackground boolean true Hide dots covered by logo
gradientPattern object null Gradient for dots: {type, rotation, colors[]}
gradientCornetsOuter object null Gradient for outer corners
gradientCornetsInterior object null Gradient for inner corners
gradientBackground object null Gradient for background
qrFrame
name string "noFrame" Frame design (200+ options or noFrame)
color string "#000000" Frame color
backgroundColor string "#ffffff" Frame background color
text string "" Frame label text (max 20 characters)
textSize integer null Font size in px (1–50)
textColor string "#9C3AAF" Frame text color
textFont string "Roboto" Font: Arial, Roboto, Georgia, Verdana…

Example Requests & Results

Explore sample API requests and the QR codes they generate.

Basic QR Code

Request URL
https://me-qr.com/api/v2/qr/link/create

Request Method
POST

Code
curl -X POST https://me-qr.com/api/v2/qr/link/create \
  -H "Content-Type: application/json" \
  -H "X-AUTH-TOKEN: YOUR_API_TOKEN" \
  -d '{
    "qrFieldsData": {
      "link": "https://example.com"
    },
    "format": "png"
  }'

QR Code Preview
Basic QR code generated via ME-QR API

QR Code with colors

Request URL
https://me-qr.com/api/v2/qr/link/create

Request Method
POST

Code
curl -X POST https://me-qr.com/api/v2/qr/link/create \
  -H "Content-Type: application/json" \
  -H "X-AUTH-TOKEN: YOUR_API_TOKEN" \
  -d '{
    "qrFieldsData": {
      "link": "https://example.com"
    },
    "format": "png",
    "qrOptions": {
      "patternColor": "#FFFFFF",
      "patternBackground": "#173782",
      "cornetsOuterColor": "#0281fb",
      "cornetsInteriorColor": "#0281fb"
    }
  }'

QR Code Preview
Colored QR code generated via ME-QR API

QR Code with frames

Request URL
https://me-qr.com/api/v2/qr/link/create

Request Method
POST

Code
curl -X POST https://me-qr.com/api/v2/qr/link/create \
  -H "Content-Type: application/json" \
  -H "X-AUTH-TOKEN: YOUR_API_TOKEN" \
  -d '{
    "qrFieldsData": {
      "link": "https://example.com"
    },
    "format": "png",
    "qrOptions": {
      "logotype": "youTubeLogotype",
      "logotypeSize": 0.3,
      "logotypeMargin": 5,
      "logotypeHideBackground": true
    },
    "qrFrame": {
      "name": "frame1",
      "color": "ff0000",
      "backgroundColor": "#ffffff",
      "text": "Scan me!",
      "textColor": "#FFFFFF"
    }
  }'

QR Code Preview
QR code with frame generated via ME-QR API

API QR Code: QR Generator API for different purposes

API QR Code is a powerful tool designed for batch QR Code creation and seamless integration into business processes, enabling automation through QR technology. This API proves instrumental in streamlining operations, enhancing efficiency, and providing a robust solution for businesses looking to incorporate QR Codes into their workflows.

A notable example of the API's functionality is demonstrated through the /api/qr/create/ endpoint, allowing you to generate QR Codes programmatically:

Post /api/qr/create/ Create QR code by type

Allows you to generate a QR code using one of the types available on me-qr. Each request will generate a new QR code.

Parameters

No parameters

Request body
application/json
{
  "token": "string",
  "qrType": 1,
  "qrFieldsData": {
    "link": "https://example.com"
  },
  "entryId": null,
  "title": "Qr Code",
  "format": "png",
  "designType": "base",
  "qrFolderOptions": {
    "folderName": null,
    "subfolderName": null
  },
  "qrOptions": {
    "size": 300,
    "errorCorrectionLevel": "Q",
    "pattern": "square",
    "patternColor": "#000000",
    "patternBackground": "#ffffff",
    "cornetsOuter": "square",
    "cornetsOuterColor": "#000000",
    "cornetsInterior": "square",
    "cornetsInteriorColor": "#000000",
    "logotype": null,
    "logotypeSize": 0.3,
    "logotypeMargin": 0,
    "logotypeHideBackground": true,
    "gradientPattern": null,
    "gradientCornetsOuter": null,
    "gradientCornetsInterior": null,
    "gradientBackground": null
  },
  "qrFrame": {
    "name": "noFrame",
    "color": "#000000",
    "backgroundColor": "#ffffff",
    "text": "",
    "textSize": null,
    "textColor": "#9C3AAF",
    "textFont": "Roboto"
  }
}
Responses
Code Description Links
default No links

QR Generator API Full Control

The Me-QR Generator API offers comprehensive control over QR Code generation, providing you with a range of features to tailor QR Codes to your specific needs:

API Countries

Retrieve a list of supported countries for custom QR code API

Get /api/v2/countries/ List of countries

Retrieve the list of available countries.

Parameters
Name Description
country
string
(query)

Search by country name.

Responses
Code Description Links
200

Successful response

application/json
[
  {
    "id": 0,
    "name": "string"
  }
]
No links

This endpoint enables you to fetch a list of available countries, facilitating localization and customization based on geographic preferences.

API Cities

Access a list of supported cities for fine-tuning QR Code details.

Get /api/v2/cities/ List of cities

Retrieve the list of available cities.

Parameters
Name Description
country
string
(query)

Search by country name.

Responses
Code Description Links
200

Successful response

application/json
[
  {
    "id": 0,
    "name": "string"
  }
]
No links

You can use this feature to select specific cities, enhancing the relevance of QR Codes for location-specific campaigns or information dissemination.

API Timezones

Obtain a list of supported timezones to incorporate time-sensitive information in QR Codes.

Get /api/v2/timezones/ List of time zones

Retrieve the list of available time zones.

Parameters
Name Description
timezone
string
(query)

Search by time zone name.

Responses
Code Description Links
200

Successful response

application/json
[
  {
    "id": 0,
    "name": "string"
  }
]
No links

This functionality allows you to align QR Code content with time-specific data, ensuring relevance and timeliness.

API Languages

Access a list of supported languages for QR Code text and content customization.

Get /api/v2/languages/ List of languages

Retrieve the list of available languages.

Parameters
Name Description
language
string
(query)

Search by language name.

Responses
Code Description Links
200

Successful response

application/json
[
  {
    "id": 0,
    "name": "string"
  }
]
No links

You can utilize this feature to cater to diverse language preferences, making QR Codes more accessible and user-friendly in multilingual contexts.

The flexibility provided by these features empowers you to create a dynamic QR Code API tailored to specific regions, cities, time zones, and languages, thereby enhancing the effectiveness of your QR-based communication and interaction strategies.

QR Generator API Types

Our QR Code Generator API offers a diverse range of types for QR Code generation, catering to various needs and functionalities. Let's explore some of these types in detail.

QR Code Payment API

Free QR code API proves valuable in the realm of payments due to its seamless and efficient nature. It simplifies transactions, enhances security, and expedites the QR Code monthly payment. Here's a simple code example demonstrating its usage:

Post /api/v2/qr/payment/create QR Code Payment API
QR Code Payment API

Free QR code API proves valuable in the realm of payments by allowing businesses and individuals to streamline transactions. By embedding a payment URL into a QR code, customers can quickly scan the code with their smartphones and complete transactions seamlessly.

Request body application/json
{
  "qrFieldsData": {
    "link"*: "https://example.com/pay"
  }
}
Field Type Required Description
link string($hostname) required Payment page URL

Generate QR Code API and revolutionize your payment processes with us, transforming transactions into seamless and efficient experiences.

Generate QR Code API and revolutionize your payment processes with us. Seamlessly integrate secure and efficient transactions into your applications.

PayPal QR Code API

One exemplary instance of a QR Code Payment API is the PayPal QR code. Renowned as a leader in online payments, PayPal's API integration streamlines transactions securely. Here's a basic illustration of its implementation:

Post /api/v2/qr/paypal/create QR Code PayPal API
QR Code PayPal API

The PayPal QR Code API enables seamless integration of PayPal payment links into QR codes. Users can scan the QR code to be instantly directed to a PayPal payment page, making transactions fast and convenient for both businesses and customers.

Request body application/json
{
  "qrFieldsData": {
    "link"*: "https://paypal.me/username"
  }
}
Field Type Required Description
link string($hostname) required PayPal.me or payment URL

Leverage the PayPal QR Code API to simplify and accelerate your payment flow, offering a modern checkout experience to your users.

Elevate your online payment experience with Me-QR's PayPal QR Code API. Effortlessly integrate secure and efficient PayPal transactions into your applications.

How to generate WhatsApp QR Code via API

The WhatsApp API QR code holds a distinguished position among messenger QR APIs. Leveraging this API facilitates seamless interaction by enabling quick access to WhatsApp, making it a leader in the realm of messenger-based QR functionalities. Here's an example:

Post /api/v2/qr/whatsapp/create QR Code WhatsApp API
QR Code WhatsApp API

The WhatsApp QR Code API allows you to generate QR codes that open a WhatsApp conversation with a pre-filled message. Simply provide a phone number and an optional message — ideal for customer support, marketing campaigns, and instant engagement.

Request body application/json
{
  "qrFieldsData": {
    "phone"*: "+1234567890",
    "message"*: "Hello!"
  }
}
Field Type Required Description
phone string required Recipient phone number in international format
message string required Pre-filled message text

Integrate the WhatsApp QR Code API to drive direct conversations and boost engagement with a single scan.

Connect with your audience seamlessly through WhatsApp QR Code. Enable quick access to conversations with just a scan, enhancing your messaging experience.

Discover more QR API types with Me-QR

QR code API free offers a comprehensive suite of QR Code API Generator types to cater to diverse needs. Explore the more supported QR API types and code examples for each:

Instagram

Connect with Instagram profiles using QR codes.

Post /api/v2/qr/instagram/create

Generate a QR code linking directly to an Instagram profile or post.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.instagram.com/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/instagram/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.instagram.com/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/instagram/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://www.instagram.com/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Facebook

Link to Facebook profiles or pages via QR Code Generator rest API.

Post /api/v2/qr/facebook/create

Generate a QR code linking to a Facebook page, group, or profile.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.facebook.com/pagename"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/facebook/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.facebook.com/pagename"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/facebook/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://www.facebook.com/pagename"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Twitter

Access Twitter profiles or tweets with QR codes.

Post /api/v2/qr/twitter/create

Create a QR code that directs users to a Twitter/X profile or tweet.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://twitter.com/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/twitter/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://twitter.com/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/twitter/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://twitter.com/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

TikTok

Discover TikTok profiles using QR codes.

Post /api/v2/qr/tiktok/create

Generate a QR code linking to a TikTok profile or video.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.tiktok.com/@username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/tiktok/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.tiktok.com/@username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/tiktok/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://www.tiktok.com/@username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Snapchat

Connect with profiles through Snapchat QR.

Post /api/v2/qr/snapchat/create

Generate a QR code linking directly to a Snapchat profile.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.snapchat.com/add/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/snapchat/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.snapchat.com/add/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/snapchat/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://www.snapchat.com/add/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Telegram

Engage with Telegram channels or groups using QR codes.

Post /api/v2/qr/telegram/create

Create a QR code linking to a Telegram channel, bot, or contact.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://t.me/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/telegram/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://t.me/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/telegram/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://t.me/username"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Spotify

Access specific Spotify songs, albums, or artists using QR codes.

Post /api/v2/qr/spotify/create

Generate a QR code that opens a Spotify track, album, or artist page.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://open.spotify.com/track/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/spotify/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://open.spotify.com/track/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/spotify/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://open.spotify.com/track/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Youtube

Watch YouTube channels or videos using QR codes.

Post /api/v2/qr/youtube/create

Create a QR code linking to a YouTube channel or video.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/youtube/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/youtube/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Video

Enjoy video playback on mobile devices using QR codes embedded with videos.

Post /api/v2/qr/video/create

Generate a QR code that links to any online video resource.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://example.com/video.mp4"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/video/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://example.com/video.mp4"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/video/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://example.com/video.mp4"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Etsy

Browse specific Etsy products using QR codes.

Post /api/v2/qr/etsy/create

Create a QR code linking to an Etsy shop or product listing.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.etsy.com/shop/storename"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/etsy/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://www.etsy.com/shop/storename"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/etsy/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://www.etsy.com/shop/storename"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Shaped

Generate QR codes with unique shapes and designs to enhance branding.

Post /api/v2/qr/shaped/create

Generate a QR code that links to any web resource with a custom shaped design.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://example.com"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/shaped/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://example.com"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/shaped/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://example.com"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

GoogleSheets

Open specific GoogleSheets spreadsheets directly using QR codes.

Post /api/v2/qr/google-sheets/create

Create a QR code linking to a shared Google Sheets document.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://docs.google.com/spreadsheets/d/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/google-sheets/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://docs.google.com/spreadsheets/d/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/google-sheets/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://docs.google.com/spreadsheets/d/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

GoogleDoc

Access specific GoogleDocs documents using QR codes.

Post /api/v2/qr/google-doc/create

Generate a QR code that opens a shared Google Docs document.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://docs.google.com/document/d/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/google-doc/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://docs.google.com/document/d/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/google-doc/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://docs.google.com/document/d/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

GoogleForms

Take surveys or quizzes using QR codes leading to specific GoogleForms.

Post /api/v2/qr/google-forms/create

Create a QR code linking to a Google Forms survey or quiz.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://forms.google.com/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/google-forms/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://forms.google.com/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/google-forms/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://forms.google.com/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

GoogleReview

Share Google My Business reviews using QR codes.

Post /api/v2/qr/google-review/create

Generate a QR code that directs customers to leave a Google review for your business.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://g.page/your-business/review"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/google-review/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://g.page/your-business/review"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/google-review/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://g.page/your-business/review"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Office365

Link to Microsoft Office 365 documents using QR codes.

Post /api/v2/qr/office365/create

Create a QR code that links to a Microsoft Office 365 document or SharePoint resource.

Request body application/json
{
  "qrFieldsData": {
    "link": "https://office365.com/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/office365/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "link": "https://office365.com/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/office365/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "link": "https://office365.com/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Email

Launch emails when QR codes are scanned, allowing users to compose messages without typing the address.

Post /api/v2/qr/email/create

Create a QR code that opens an email client with pre-filled recipient, subject, and message body.

Request body application/json
{
  "qrFieldsData": {
    "emailTo": "user@example.com",
    "subject": "Hello",
    "body": "Your message here"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/email/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "emailTo": "user@example.com",
    "subject": "Hello",
    "body": "Your message here"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/email/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "emailTo": "user@example.com",
    "subject": "Hello",
    "body": "Your message here"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Phone

Dial phone numbers directly using QR codes linking to phone numbers.

Post /api/v2/qr/phone/create

Generate a QR code that automatically dials a phone number when scanned.

Request body application/json
{
  "qrFieldsData": {
    "phoneTo": "+1234567890"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/phone/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "phoneTo": "+1234567890"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/phone/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "phoneTo": "+1234567890"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

WiFi

Generate QR codes for Wi-Fi networks, including SSID, password, and security type.

Post /api/v2/qr/wifi/create

Create a QR code that connects users to a WiFi network automatically.

Request body application/json
{
  "qrFieldsData": {
    "ssid": "NetworkName",
    "encryption": "wpa/wpa2",
    "password": "secret123"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/wifi/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "ssid": "NetworkName",
    "encryption": "wpa/wpa2",
    "password": "secret123"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/wifi/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "ssid": "NetworkName",
    "encryption": "wpa/wpa2",
    "password": "secret123"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Text

Share messages or information using QR codes containing plain text.

Post /api/v2/qr/text/create

Generate a QR code that displays plain text or HTML content when scanned.

Request body application/json
{
  "qrFieldsData": {
    "text": "Your custom text here"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/text/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "text": "Your custom text here"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/text/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "text": "Your custom text here"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Map

Access specific locations, such as addresses, landmarks, or points of interest, via API for QR Code.

Post /api/v2/qr/map/create

Create a QR code that opens a specific location in Google Maps.

Request body application/json
{
  "qrFieldsData": {
    "latitude": "48.8566",
    "longitude": "2.3522"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/map/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "latitude": "48.8566",
    "longitude": "2.3522"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/map/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "latitude": "48.8566",
    "longitude": "2.3522"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

AppStore

Install App Store apps directly by scanning their respective QR codes.

Post /api/v2/qr/store/create

Generate a smart QR code that redirects to App Store or Google Play based on the user's device.

Request body application/json
{
  "qrFieldsData": {
    "iosLink": "https://apps.apple.com/app/...",
    "androidLink": "https://play.google.com/store/apps/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/store/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "iosLink": "https://apps.apple.com/app/...",
    "androidLink": "https://play.google.com/store/apps/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/store/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "iosLink": "https://apps.apple.com/app/...",
    "androidLink": "https://play.google.com/store/apps/..."
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

VCard

Share contact information seamlessly using QR codes in VCard format.

Post /api/v2/qr/vcard/create

Create a digital business card QR code. Users can save your contact info directly to their phone.

Request body application/json
{
  "qrFieldsData": {
    "name": "John",
    "lastName": "Doe",
    "organization": "Acme Corp",
    "position": "CEO",
    "phones": [{ "phone": "+1234567890", "type": "mobile" }],
    "emails": [{ "email": "john@example.com" }],
    "websites": [{ "url": "https://example.com" }]
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/vcard/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "name": "John",
    "lastName": "Doe",
    "organization": "Acme Corp",
    "position": "CEO",
    "phones": [{ "phone": "+1234567890", "type": "mobile" }],
    "emails": [{ "email": "john@example.com" }],
    "websites": [{ "url": "https://example.com" }]
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/vcard/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "name": "John",
    "lastName": "Doe",
    "organization": "Acme Corp",
    "position": "CEO",
    "phones": [{ "phone": "+1234567890", "type": "mobile" }],
    "emails": [{ "email": "john@example.com" }],
    "websites": [{ "url": "https://example.com" }]
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Image

View images directly on mobile devices using QR codes embedding images.

Post /api/v2/qr/gallery/create

Generate a QR code that opens an image gallery. Upload 1–20 images as base64 or provide URLs.

Request body application/json
{
  "qrFieldsData": {
    "images": [
      {
        "file": "https://example.com/photo.jpg",
        "fileName": "photo.jpg"
      }
    ]
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/gallery/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "images": [
      {
        "file": "https://example.com/photo.jpg",
        "fileName": "photo.jpg"
      }
    ]
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/gallery/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "images": [
      {
        "file": "https://example.com/photo.jpg",
        "fileName": "photo.jpg"
      }
    ]
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

File

Share files of any format by embedding a download link into a QR code for instant mobile access.

Post /api/v2/qr/file/create

Generate a QR code that links to a downloadable file. Provide as base64 or a direct URL.

Request body application/json
{
  "qrFieldsData": {
    "file": "https://example.com/document.pdf",
    "fileName": "document.pdf"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/file/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "file": "https://example.com/document.pdf",
    "fileName": "document.pdf"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/file/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "file": "https://example.com/document.pdf",
    "fileName": "document.pdf"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

PDF

Embed PDF documents into QR codes for easy access on mobile devices.

Post /api/v2/qr/pdf/create

Create a QR code that opens a PDF document in the browser when scanned.

Request body application/json
{
  "qrFieldsData": {
    "file": "https://example.com/document.pdf",
    "fileName": "document.pdf"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/pdf/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "file": "https://example.com/document.pdf",
    "fileName": "document.pdf"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/pdf/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "file": "https://example.com/document.pdf",
    "fileName": "document.pdf"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

Audio

Enjoy audio playback on mobile devices using QR codes embedding audio files.

Post /api/v2/qr/audio/create

Generate a QR code that plays an audio file — perfect for music, podcasts, or voice messages.

Request body application/json
{
  "qrFieldsData": {
    "file": "https://example.com/audio.mp3",
    "fileName": "audio.mp3"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/audio/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "file": "https://example.com/audio.mp3",
    "fileName": "audio.mp3"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/audio/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "file": "https://example.com/audio.mp3",
    "fileName": "audio.mp3"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

PPTX

Present PowerPoint presentations effortlessly with QR code embedding presentations.

Post /api/v2/qr/pptx/create

Create a QR code that opens or downloads a PowerPoint presentation when scanned.

Request body application/json
{
  "qrFieldsData": {
    "file": "https://example.com/presentation.pptx",
    "fileName": "presentation.pptx"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/pptx/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "file": "https://example.com/presentation.pptx",
    "fileName": "presentation.pptx"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/pptx/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "file": "https://example.com/presentation.pptx",
    "fileName": "presentation.pptx"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

PCR

Share and verify PCR test results conveniently using the Covid testing QR Code.

Post /api/v2/qr/pcr/create

Generate a QR code for a health or compliance certificate with password protection and expiration date.

Request body application/json
{
  "qrFieldsData": {
    "file": "https://example.com/certificate.pdf",
    "fileName": "certificate.pdf",
    "expireDate": "2025-12-31",
    "password": "secret"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Put /api/v2/qr/pcr/update/{entryUID}

Changing data and styling parameters of QR code.

Parameters

entryUIDpath  Id or unique entry key (QR code)

Request body application/json
{
  "qrFieldsData": {
    "file": "https://example.com/certificate.pdf",
    "fileName": "certificate.pdf",
    "expireDate": "2025-12-31",
    "password": "secret"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }
Get /api/v2/qr/pcr/{entryUID}

View data and customization settings or the image itself of the generated QR code.

Parameters

entryUID path  Id or unique entry key (QR code)

format query  Image format. Available values: png, svg, jpg, jpeg, json. Default: null

Response 200 application/json
{
  "qrFieldsData": {
    "file": "https://example.com/certificate.pdf",
    "fileName": "certificate.pdf",
    "expireDate": "2025-12-31",
    "password": "secret"
  },
  "title": "Qr Code",
                        "format": "png",
                        "designType": "base",
                        "qrFolderOptions": {
                        "folderName": null,
                        "subfolderName": null
                        },
                        "qrOptions": {
                        "size": 300,
                        "errorCorrectionLevel": "Q",
                        "pattern": "square",
                        "patternColor": "#000000",
                        "patternBackground": "#ffffff",
                        "cornetsOuter": "square",
                        "cornetsOuterColor": "#000000",
                        "cornetsInterior": "square",
                        "cornetsInteriorColor": "#000000",
                        "logotype": null,
                        "logotypeSize": 0.3,
                        "logotypeMargin": 0,
                        "logotypeHideBackground": true,
                        "gradientPattern": null,
                        "gradientCornetsOuter": null,
                        "gradientCornetsInterior": null,
                        "gradientBackground": null
                        },
                        "qrFrame": {
                        "name": "noFrame",
                        "color": "#000000",
                        "backgroundColor": "#ffffff",
                        "text": "",
                        "textSize": null,
                        "textColor": "#9C3AAF",
                        "textFont": "Roboto"
                        }
                        }

The online QR Code Generator API provides a diverse range of QR API types to address various needs. From directing users to websites, sharing contact information, accessing specific locations, engaging with social media profiles, and more.

Elevate your routine with the Me-QR API

Elevate your QR code creation to a whole new level with our API QR Code Generator, a groundbreaking tool that simplifies and streamlines QR code generation processes. This exclusive feature, available only on our Premium plan, empowers developers and businesses to seamlessly integrate QR code creation into their applications and workflows, enhancing efficiency and productivity.

ME-QR API effortlessly integrates with your existing systems, allowing you to automate QR code generation and effortlessly embed QR codes into your applications, websites, and workflows. This eliminates the need for manual QR code creation, saving you valuable time and effort while ensuring consistent branding and functionality across all platforms.

With ME-QR API's cross-platform compatibility, encompassing Android, iOS, and Windows, you can create QR codes from anywhere and integrate them seamlessly into your digital assets.

Embrace the power of QR Code web API and elevate your QR code creation capabilities. Experience the unmatched efficiency and productivity that our Premium plan offers. Subscribe today and start automating your QR code generation tasks!

Frequently Asked Questions