Black & white Colored With frames With logo Background image
Static
Dynamic
In Bulk

Integrate the QR Code API with your system - quick & easy

Whether you are looking to integrate the QR code generator API with your Android, iOS system or your workflow, it takes just 15 mins!

STEP 1: Sign up for a free API trial

STEP 2: Get the developer token (your API key)

STEP 3: Create QR Code

STEP 4: Download QR Code

QR Code API for basic black & white QR Codes

Use this API to generate QR codes in their most basic format - black and white. Recommended for payments, employee ID cards, document verification or employment history.

STATIC

DYNAMIC

REQUEST URL:

https://beaconstac.mobstac.com/api/2.0/qrcodes/

REQUEST METHOD:

POST

REQUEST HEADER:

Authorization: Token <YOUR_TOKEN>

Content-Type: application/json

REQUEST BODY:

{

"name": "Static BnW QR Code",
"qr_type": 1,
"organization": <YOUR_ORG_ID>,

"attributes":{

"color": "#000000",
"margin": 25

},

"fields_data": {

"qr_type": 1,
"url": "https://www.example.com"

}

}

Create black-and-white QR Codes that have a fixed URL behind it. Once printed, the link behind the QR Code cannot be changed

SAMPLE QR CODES
REQUEST URL:

https://beaconstac.mobstac.com/api/2.0/qrcodes/

REQUEST METHOD:

POST

REQUEST HEADER:

Authorization: Token <YOUR_TOKEN>

Content-Type: application/json

REQUEST BODY:

{

"name": "Dynamic BnW QR Code",
"qr_type": 2,
"organization": <YOUR_ORG_ID>,

"attributes": {

"color": "#000000",
"margin": 25

},

"campaign": {

"custom_url": "https://www.example.com",
"content_type": 1

}

}

Create black-and-white QR Codes which have the flexibility to rotate, modify or schedule campaigns (URLs) linked to them

SAMPLE QR CODES

QR Code generator API for colored QR Codes

Reinforce branding on QR Codes by modifying the color of QR Codes. Using a QR code with brand colors establishes trust and ergo increases the engagement. Recommended for all customer-facing marketing assets, such as product packaging, business cards, billboards, and posters.

STATIC

DYNAMIC

REQUEST URL:

https://beaconstac.mobstac.com/api/2.0/qrcodes/

REQUEST METHOD:

POST

REQUEST HEADER:

Authorization: Token <YOUR_TOKEN>

Content-Type: application/json

REQUEST BODY:

{

"name": "Static Colored QR Code",
"qr_type": 1,
"organization": <YOUR_ORG_ID>,

"attributes": {

"color": "#fb6e6e",
"margin": 25

},

"fields_data": {

"qr_type": 1,
"url": "https://www.example.com"

}

}

Create a colored QR Code with a fixed URL. Useful for an event pass or corporate presentations

SAMPLE QR CODES
REQUEST URL:

https://beaconstac.mobstac.com/api/2.0/qrcodes/

REQUEST METHOD:

POST

REQUEST HEADER:

Authorization: Token <YOUR_TOKEN>

Content-Type: application/json

REQUEST BODY:

{

"name": "Dynamic color QR Code",
"qr_type": 2,
"organization": <YOUR_ORG_ID>,

"attributes": {

"color": "#fb6e6e",
"margin": 25

},

"campaign": {

"custom_url": "https://www.example.com",
"content_type": 1

}

}

Create QR Codes in your brand colors or color of your choice. These QR Codes are dynamic in nature and can rotate, modify or schedule campaigns (URLs) linked to them

SAMPLE QR CODES

QR Code API for QR Codes with frames

QR code frames are add-ons that make a basic QR code stand out. Every frame we provide has a distinct call-to-action that encourages the user to scan the QR code. It gives a hint of what happens when a user scans the QR.

STATIC

DYNAMIC

REQUEST URL:

https://beaconstac.mobstac.com/api/2.0/qrcodes/

REQUEST METHOD:

POST

REQUEST HEADER:

Authorization: Token <YOUR_TOKEN>

Content-Type: application/json

REQUEST BODY:

{

"name": "Static frame QR Code",
"qr_type": 1,
"organization": <YOUR_ORG_ID>,

"attributes": {

"color": "#000000",
"margin": 25,
"frameStyle": "banner-top"

},

"fields_data": {

"qr_type": 1,
"url": "https://www.example.com"

}

}

Create static QR codes and make them stand out with frames that can be customized based on the marketing campaign. Recommended for static QR codes that drive app downloads.

SAMPLE QR CODES
REQUEST URL:

https://beaconstac.mobstac.com/api/2.0/qrcodes/

REQUEST METHOD:

POST

REQUEST HEADER:

Authorization: Token <YOUR_TOKEN>

Content-Type: application/json

REQUEST BODY:

{

"name": "Dynamic frame QR Code",
"qr_type": 2,
"organization": <YOUR_ORG_ID>,

"attributes": {

"color": "#fb6e6e",
"margin": 25,
"frameStyle": "banner-top"

},

"campaign": {

"custom_url": "https://www.example.com",
"content_type": 1

}

}

Create dynamic QR Codes with frames that call out - “Scan for daily offers”, or “Scan to see our latest collection.” Keep updating campaigns linked to this QR code without reprinting and redistributing QR codes.

SAMPLE QR CODES

QR Code API for QR with logo

Create QR codes with brand logos or icons that hint of what happens when a user scans it. Adding a logo to the QR Code establishes brand credibility and adding an icon increases engagement.

STATIC

DYNAMIC

REQUEST URL:

https://beaconstac.mobstac.com/api/2.0/qrcodes/

REQUEST METHOD:

POST

REQUEST HEADER:

Authorization: Token <YOUR_TOKEN>

Content-Type: application/json

REQUEST BODY:

{

"name": "Static logos QR Code",
"qr_type": 1,
"organization": <YOUR_ORG_ID>,

"attributes": {

"color": "#000000",
"margin": 25,
"logoImage": <IMAGE_URL>

},

"fields_data": {

"qr_type": 1,
"url": "https://www.example.com"

}

}

Create non-editable QR Codes with logo. Recommended for corporate events with attendees’ company logos or to distinguish a PDF QR code from a YouTube QR code on a presentation deck.

SAMPLE QR CODES
REQUEST URL:

https://beaconstac.mobstac.com/api/2.0/qrcodes/

REQUEST METHOD:

POST

REQUEST HEADER:

Authorization: Token <YOUR_TOKEN>

Content-Type: application/json

REQUEST BODY:

{

"name": "Dynamic frame QR Code",
"qr_type": 2,
"organization": <YOUR_ORG_ID>,

"attributes": {

"color": "#fb6e6e",
"margin": 25,
"logoImage": <IMAGE_URL>

},

"campaign": {

"custom_url": "https://www.example.com",
"content_type": 1

}

}

Create branded QR codes with logo. Rotate campaigns (URL) linked to the QR code. Recommended for F&B campaigns, cosmetic brands and more.

SAMPLE QR CODES
QR CODE GENERATOR API - PARAMETER LIST

Use the QR Code API parameters to generate your QR Codes

Parameter Name Type Required Read Only Description
id integer false true Unique identifier for the object
name string true false The name of the QR Code
attributes object true false Attributes data for the QR Code
qr_type integer false false QR type (1 Static, 2 Dynamic)
Default: 2 Dynamic
fields_data object true false Fields data for the QR Code.
Required for Static QR Codes only
campaign timestamp true false Campaign object.
Required for Dynamic QR Codes only
organization integer true true Organization id
place integer false false Place id
url string false true QR Code URL
state string false true State of the QR Code
(A Active, S Sleeping)
place_data list[object] false true Place data associated with place id.
Only available in list
tags list[object] false false List of the tag ids associated
tag_data list[object] false true Tag data
meta object false false Metadata associated with the QR Code
created timestamp false true Created timestamp
updated timestamp false true Last updated timestamp
heartbeat timestamp false true Timestamp when the QR Code was last detected
Parameter Name Type Default Description
margin string 15 Margin to be applied around QR Code
dotScale string 0.35 Size of each dot [0-1]
backgroundImage string null URL of background image
backGroundColor string #ffffff Background color in format #RRGGBB
eyeFrameShape string square
square:
circle:
rounded:
left-leaf:
right-leaf:
eyeBallShape string square
square:
circle:
rounded:
left-leaf:
left-diamond:
right-diamond:
eyeFrameColor string #000000 Eye Frame color in format #RRGGBB
eyeBallColor string #000000 Eye Ball color in format #RRGGBB
dataPattern string square
square:
circle:
kite:
left-diamond:
right-diamond:
colorDark string #000000 Data Pattern color dark in format #RRGGBB
colorLight string #ffffff Data Pattern color light in format #RRGGBB
gradientType string none none, linear, radial
frameStyle string none
None
banner-top:
box-top:
box-bottom:
banner-bottom:
balloon-top:
balloon-bottom:
frameColor string #000000 Frame color in format #RRGGBB
frameText string SCAN ME Text to be displayed in frame
logoImage string null URL of logo image
logoScale string 0.15 Size of logo [0-1]
logoCornerRadius string 8 Radius of corners of logo
logoMargin string 0.15 Margin to be applied around logo image
Parameter Name Type Required Read Only Description
qr_type integer true true

Defines the QR Code type

qr_type = 1 (Website QR Code)

Required fields: url

qr_type = 2 (SMS QR Code)

Required fields: phone, text

qr_type = 3 (Call QR Code)

Required fields: phone

qr_type = 4 (Email QR Code)

Required fields: email, subject, body

qr_type = 5 (vCard QR Code)

Required fields: first_name, last_name, phone, email, address_line1, address_line2, city, state, country, zip, website

qr_type = 6 (Text QR Code)

Required fields: text

url string true true URL of the website
phone string true true Recipient phone number
text string false true Default SMS text
email string true true Recipient e-mail
subject string false true Default mail subject
body string false true Default mail body
first_name string true true First Name of the Recipient
last_name string true true Last Name of the Recipient
last_name string true true Last Name of the Recipient
address_line1 string false true Address line1 of Recipient
address_line2 string false true Address line2 of Recipient
city string false true City of Recipient
state string false true State of Recipient
country string false true Country of Recipient
zip string false true Zip-code of Recipient
website string false true Website of Recipient
Parameter Name Type Required Read Only Description
content_type integer true false

Defines the campaign type

content_type = 1 (Custom URL campaigns)

Required fields: custom_url

content_type = 2 (Markdown Card campaigns)

Required fields: markdown_card

content_type = 3 (Form campaigns)

Required fields: form

content_type = 5 (App Links campaigns)

Required fields: fallback_url, android_url, iphone_url, ipad_url

custom_url string true false Url the campaign is pointed to
markdown_card integer true false <MarkdownCard_ID>
form integer true false <Form_ID>
app_links JSON true false Specifies the device specific URLs that the campaign should point to.
fallback_url JSON true false URL to redirect if device is not an Android and iOS
android_url string false false URL to redirect if device is an Android
iphone_url string false false URL to redirect if device is an iPhone
ipad_url string false false URL to redirect if device is an iPad. Uses iphone_url if not specified.