-
PRODUCT
What is QR Code API?
QR Code API is an application programming interface that you can integrate with your app or website to create customized QR Codes of your choice.
Whether it’s bulk QR Codes, QR Codes with logos, or QR Codes for business cards, vCards, and coupons, an online QR Code generator API lets you create QR Codes to suit every intent.
QR Code Generator API built for all
your business needsQR Code Generator API built for all your business needs
Black & white Colored With frames With logo Background image Static ![check-icon]()
![check-icon]()
![check-icon]()
![check-icon]()
![check-icon]()
Dynamic ![check-icon]()
![check-icon]()
![check-icon]()
![check-icon]()
![check-icon]()
In Bulk ![check-icon]()
![check-icon]()
![check-icon]()
![check-icon]()
![check-icon]()
Integrate the QR Code Generator 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
![Sign up for a free API trial image]()
curl -X POST \
https://api.beaconstac.com/api/2.0/qrcodes/ \
-H 'Authorization: Token <TOKEN_ID>' \
-H 'Content-Type: application/json' \
-d '{
"name": "My QR Code",
"qr_type": 2,
"organization": <YOUR_ORG_ID>,
"attributes": {
"color": "#000000",
"margin": 25
},
"campaign": {
"custom_url": "https://www.example.com",
"content_type": 1
}
}'
curl -X GET \
'https://api.beaconstac.com/api/2.0/qrcodes/<QR_CODE_ID>/download/?canvas_type=png' \
-H 'Authorization: Token <TOKEN_ID>' \
QR Code Generator API for basic black & white QR Codes
Use the online QR Code generator API to generate simple QR Codes in their most basic format - black and white. Recommended for payments, employee ID cards, document verification or employment history.
REQUEST URL:
https://api.beaconstac.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>,
"color": "#000000",
"margin": 25
},
"qr_type": 1,
"url": "https://www.example.com"
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"tag_data": [],
"meta": {
"notes": ""
},
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"fields_data": {
"qr_type": 1,
"url": "https://www.example.com"
},
"campaign": null,
"attributes": {
"color": "#000000",
"margin": 25
},
"url": <QR_CODE_URL>,
"name": "Static BnW QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 1,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Use the QR Code API to make black-and-white QR Codes that have a fixed URL behind them. Once printed, the link behind the QR Code cannot be changed
SAMPLE QR CODES
![Black & white QR Codes example]( "Black & white QR Codes example")
![Black & white QR Codes example]( "Black & white QR Codes example")
REQUEST URL:
https://api.beaconstac.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
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"tag_data": [],
"meta": {
"notes": "",
"activationTimestamp": 1565699487
},
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"campaign": {
"id": 20224,
"name": "https://www.example.com",
"app_links": {},
"custom_url": "https://www.example.com",
"content_type": 1,
"campaign_active": true,
"created": <CAMPAIGN_CREATED_AT>,
"updated": <CAMPAIGN_UPDATED_AT>,
"organization": <YOUR_ORG_ID>,
"markdown_card": null,
"form": null,
"schedule": null
},
"fields_data": {},
"attributes": {
"color": "#000000",
"margin": 25
}
"url": <QR_CODE_URL>,
"name": "Dynamic BnW QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 2,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Create black-and-white QR Codes using the dynamic QR Code API. They have the flexibility to rotate, modify or schedule campaigns (URLs) linked to them
SAMPLE QR CODES
![Black & white QR Codes example]( "Black & white QR Codes example")
![Black & white QR Codes example]( "Black & white QR Codes example")
Custom QR Code API for colored QR Codes
Reinforce branding by modifying the color of QR Codes. Using the free QR Code generator API, add your brand colors to QR Codes to establish trust and ergo increase engagement. Recommended for all customer-facing marketing assets, such as product packaging, digital business cards, billboards, and posters.
REQUEST URL:
https://api.beaconstac.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
},
"qr_type": 1,
"url": "https://www.example.com"
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"tag_data": [],
"meta": {
"notes": ""
},
"fields_data": {
"qr_type": 1,
"url": "https://www.example.com"
},
"campaign": null,
"attributes": {
"color": "#fb6e6e",
"margin": 25
},
"url": <QR_CODE_URL>,
"name": "Static colored QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 1,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Make a colored QR Code with a fixed URL. Useful for an event pass or corporate presentations
SAMPLE QR CODES
![Colour QR Codes example]( "Colour QR Codes example")
![Colour QR Codes example]( "Colour QR Codes example")
REQUEST URL:
https://api.beaconstac.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
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"tag_data": [],
"meta": {
"notes": "",
"activationTimestamp": 1565699487
},
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"campaign": {
"id": 20224,
"name": "https://www.example.com",
"app_links": {},
"custom_url": "https://www.example.com",
"content_type": 1,
"campaign_active": true,
"created": <CAMPAIGN_CREATED_AT>,
"updated": <CAMPAIGN_UPDATED_AT>,
"organization": <YOUR_ORG_ID>,
"markdown_card": null,
"form": null,
"schedule": null
},
"fields_data": {},
"attributes": {
"color": "#fb6e6e",
"margin": 25
}
"url": <QR_CODE_URL>,
"name": "Dynamic color QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 2,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Create custom QR Codes in your brand colors or colors of your choice. The dynamic QR Code generator API lets you rotate, modify or schedule campaigns (URLs) linked to your QR Codes.
SAMPLE QR CODES
![Colour QR Codes example]( "Colour QR Codes example")
![Colour QR Codes example]( "Colour QR Codes example")
QR Code Generator API for QR Codes with frames
The best QR Code API lets you add frames to make a simple 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.
REQUEST URL:
https://api.beaconstac.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"
},
"qr_type": 1,
"url": "https://www.example.com"
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"tag_data": [],
"meta": {
"notes": ""
},
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"fields_data": {
"qr_type": 1,
"url": "https://www.example.com"
},
"campaign": null,
"attributes": {
"color": "#000000",
"margin": 25,
"frameStyle": "banner-top"
},
"url": <QR_CODE_URL>,
"name": "Static frame QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 1,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Create static QR Codes using the custom QR Code API. 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
![Frame QR Codes example]( "Frame QR Codes example")
![Frame QR Codes example]( "Frame QR Codes example")
REQUEST URL:
https://api.beaconstac.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
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"tag_data": [],
"meta": {
"notes": "",
"activationTimestamp": 1565699487
},
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"campaign": {
"id": 20224,
"name": "https://www.example.com",
"app_links": {},
"custom_url": "https://www.example.com",
"content_type": 1,
"campaign_active": true,
"created": <CAMPAIGN_CREATED_AT>,
"updated": <CAMPAIGN_UPDATED_AT>,
"organization": <YOUR_ORG_ID>,
"markdown_card": null,
"form": null,
"schedule": null
},
"fields_data": {},
"attributes": {
"color": "#fb6e6e",
"margin": 25,
"frameStyle": "banner-top"
},
"url": <QR_CODE_URL>,
"name": "Dynamic frame QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 2,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Use the dynamic QR Code API to 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
![Frame QR Codes example]( "Frame QR Codes example")
![Frame QR Codes example]( "Frame QR Codes example")
QR Code Generator API for QR with logo
Create custom QR Codes with brand logos or icons using the QR Code API with logo to hint at what happens when a user scans it. Add a logo to the QR Code to establish brand credibility, and add an icon to increase engagement.
REQUEST URL:
https://api.beaconstac.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>
},
"qr_type": 1,
"url": "https://www.example.com"
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"tag_data": [],
"meta": {
"notes": ""
},
"fields_data": {
"qr_type": 1,
"url": "https://www.example.com"
},
"campaign": null,
"attributes": {
"color": "#000000",
"margin": 25,
"logoImage": <IMAGE_URL>
},
"url": <QR_CODE_URL>,
"name": "Static logos QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 1,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Use the QR Code API to create non-editable QR Codes with a 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
![QR Codes with Logo example]( "QR Codes with Logo example")
![QR Codes with Logo example]( "QR Codes with Logo example")
REQUEST URL:
https://api.beaconstac.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
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"tag_data": [],
"meta": {
"notes": "",
"activationTimestamp": 1565699487
},
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"campaign": {
"id": 20224,
"name": "https://www.example.com",
"app_links": {},
"custom_url": "https://www.example.com",
"content_type": 1,
"campaign_active": true,
"created": <CAMPAIGN_CREATED_AT>,
"updated": <CAMPAIGN_UPDATED_AT>,
"organization": <YOUR_ORG_ID>,
"markdown_card": null,
"form": null,
"schedule": null
},
"fields_data": {},
"attributes": {
"color": "#fb6e6e",
"margin": 25,
"logoImage": <IMAGE_URL>
}
"url": <QR_CODE_URL>,
"name": "Dynamic color QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 2,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Make branded QR codes with a logo using the dynamic QR Code API. Rotate campaigns (URL) linked to the QR Code. Recommended for F&B campaigns, cosmetic brands and more.
SAMPLE QR CODES
![QR Codes with logo example]( "QR Codes with logo example")
![QR Codes with logo example]( "QR Codes with logo example")
Best QR Code API for creating vCard QR Codes
Use the QR Code API to make vCard QR Codes to allow anyone to add your contact information instantly. Place these QR Codes on business cards, brochures or flyers for easy access.
REQUEST URL:
https://api.beaconstac.com/api/2.0/qrcodes/
REQUEST METHOD:
POST
REQUEST HEADER:
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
REQUEST BODY:
{
"name": "Static vCard QR Code",
"qr_type": 1,
"organization": <YOUR_ORG_ID>,
"attributes": {
"color": "#000000",
"margin": 25,
"logoImage": <IMAGE_URL>
},
"qr_type": 5,
"first_name": "John",
"last_name": "Doe",
"phone": {
"mobile": "9876543210",},
"work": "9012345678"
"email": "john_doe@example.com",
"company": "Beaconstac.",
"designation": "Android Developer"
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"tag_data": [],
"meta": {
"notes": ""
},
"fields_data": {
"qr_type": 5,
"first_name": "John",
"last_name": "Doe",
"phone": {
"mobile": "9876543210",},
"work": "9012345678"
"email": "john_doe@example.com",
"company": "Beaconstac",
"designation": "Android Developer"
},
"campaign": null,
"attributes": {
"color": "#000000",
"margin": 25,
"logoImage": <IMAGE_URL>
},
"url": <QR_CODE_URL>,
"name": "Static vcard QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 1,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Make non-editable Static vCard QR Codes for one-time use at a conference, meeting or a seminar.
SAMPLE QR CODES
![vCard QR Codes example]( "vCard QR Codes example")
![vCard QR Codes example]( "vCard QR Codes example")
REQUEST URL:
https://api.beaconstac.com/api/2.0/qrcodes/
REQUEST METHOD:
POST
REQUEST HEADER:
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
REQUEST BODY:
{
"name": "Dynamic vCard QR Code",
"qr_type": 2,
"organization": <YOUR_ORG_ID>,
"attributes": {
"color": "#fb6e6e",
"margin": 25,
"logoImage": <IMAGE_URL>
},
"campaign": {
"content_type": 7,
"vcard_plus": {
"first_name": "John",}
"last_name": "Doe",
"user_image_url": <USER_IMAGE_URL>,
"designation": "Android Developer",
"company": "Beaconstac",
"summary": "Hello there!!!!",
"phone": {
"mobile": "9876543210",},
"work": "9012345678"
"email": "john_doe@example.com",
"address_line1": "#316 Mobstac",
"address_line2": "Indiranagar",
"city": "Bengaluru",
"zip": "560038",
"country": "India",
"address_url": <ADDRESS_URL>,
"website": "https://www.example.com",
"logo_url": <LOGO_URL>,
"customizations": {
"background_color": "#2594FF",}
"user_info_color": "#FFFFFF"
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"tag_data": [],
"meta": {
"notes": "",
"activationTimestamp": 1565699487
},
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"campaign": {
"id": 20224,
"name": "https://www.example.com",
"app_links": {},
,"vcard_plus": {
"first_name": "John",}
"last_name": "Doe",
"user_image_url": <USER_IMAGE_URL>,
"designation": "Android Developer",
"company": "Beaconstac",
"summary": "Hello there!!!!",
"phone": {
"mobile": "9876543210",},
"work": "9012345678"
"email": "john_doe@example.com",
"address_line1": "#316 Mobstac",
"address_line2": "Indiranagar",
"city": "Bengaluru",
"zip": "560038",
"country": "India",
"address_url": <ADDRESS_URL>,
"website": "https://www.example.com",
"logo_url": <LOGO_URL>,
"customizations": {
"background_color": "#2594FF",}
"user_info_color": "#FFFFFF"
"custom_url": "https://www.example.com",
"content_type": 7,
"campaign_active": true,
"created": <CAMPAIGN_CREATED_AT>,
"updated": <CAMPAIGN_UPDATED_AT>,
"organization": <YOUR_ORG_ID>,
"markdown_card": null,
"form": null,
"schedule": null
},
"fields_data": {},
"attributes": {
"color": "#fb6e6e",
"margin": 25,
"logoImage": <IMAGE_URL>
}
"url": <QR_CODE_URL>,
"name": "Dynamic color QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 2,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Use the dynamic QR Code API to create editable vCard QR Codes for employee details or long-term use. You can edit these QR Codes in real-time and as frequently as needed
SAMPLE QR CODES
![vCard QR Codes example]( "vCard QR Codes example")
![vCard QR Codes example]( "vCard QR Codes example")
Dynamic QR Code API for Business Cards
The QR Code API lets you create QR Codes for Business Cards that link to your website, landing page, product information, how-to videos or contact details.
**Static QR Codes of type business card not supported
REQUEST URL:
https://api.beaconstac.com/api/2.0/qrcodes/
REQUEST METHOD:
POST
REQUEST HEADER:
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
REQUEST BODY:
{
"name": "Business Card QR Code",
"qr_type": 1,
"organization": <YOUR_ORG_ID>,
"attributes": {
"color": "#000000",
"margin": 25,
"logoImage": <IMAGE_URL>
},
"campaign": {
"content_type": 11,
"business_card": {
"business_name": "John's Cafe",}
"headline": "Freshly prepared",
"message": "Best coffee in the sub-continent",
"button_url": "https://www.example.com/view-menu",
"button_title": "VIEW MENU",
"address": <ADDRESS>,
"address_url": <ADDRESS_URL>,
"logo_url": <LOGO_URL>,
"open_hours": {
}"monday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"tuesday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"wednesday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"thursday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"friday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"saturday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"sunday": {
}"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"customizations": {
"button_color": "#FFA500"}
"contact": {
"name": "John Doe",}
"phone": "9012345678",
"email": "john_doe@example.com",
"website": "https://www.example.com"
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"tag_data": [],
"meta": {
"notes": ""
},
"campaign": {
"content_type": 11,
"business_card": {
"business_name": "John's Cafe",}
"headline": "Freshly prepared",
"message": "Best coffee in the sub-continent",
"button_url": "https://www.example.com/view-menu",
"button_title": "VIEW MENU",
"address": <ADDRESS>,
"address_url": <ADDRESS_URL>,
"logo_url": <LOGO_URL>,
"open_hours": {
}"monday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"tuesday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"wednesday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"thursday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"friday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"saturday": {
},"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"sunday": {
}"opens": {
"hours": <OPENING_HOUR (0-24)>,}
"minutes": <OPENING_MINUTE (0-59)>
"closes": {
"hours": <CLOSING_HOUR (0-24)>,}
"minutes": <CLOSING_MINUTE (0-59)>
"is_closed": <BOOLEAN>
"customizations": {
"button_color": "#FFA500"}
"contact": {
"name": "John Doe",}
"phone": "9012345678",
"email": "john_doe@example.com",
"website": "https://www.example.com"
}
"attributes": {
"color": "#000000",
"margin": 25,
"logoImage": <IMAGE_URL>
},
"url": <QR_CODE_URL>,
"name": "Coupon QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 1,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Create branded Dynamic QR Codes for your business cards that you can edit, update or switch URLs based on analytics. The dynamic QR Code API is recommended for SMBs and enterprises to increase brand awareness and generate leads.
SAMPLE QR CODES
![QR Codes for business cards example]( "QR Codes for business cards example")
![QR Codes for business cards example]( "QR Codes for business cards example")
Dynamic QR Code Generator API for Coupons
Make Coupon QR Codes using the QR Code API to offer discounts and deals to your consumers, improve conversions, and generate leads. Place these in-store or on print or digital material to maximize your ROI.
**Static Coupon QR Codes are not supported
Static QR Codes not supported for coupon codesREQUEST URL:
https://api.beaconstac.com/api/2.0/qrcodes/
REQUEST METHOD:
POST
REQUEST HEADER:
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
REQUEST BODY:
{
"name": "Coupon QR Code",
"qr_type": 1,
"organization": <YOUR_ORG_ID>,
"attributes": {
"color": "#000000",a
"margin": 25,
"logoImage": <IMAGE_URL>
},
"campaign": {
"content_type": 10,
"coupon": {
"coupon_code": "ABCD1234",}
"header": "Flat 25% off",
"expires_at": <EXPIRY DATE IN ISO FORMAT>,
"message": "Big sale at Beaconstac stores",
"company_name": "Beaconstac",
"terms_and_conditions": <COUPON T&C>,
"description_header": "Big Holiday sale",
"description_body": "Enjoy the biggest holiday sale",
"location": <ADDRESS_URL>,
"website": "https://www.example.com",
"logo_url": <LOGO_URL>,
"customizations": {
"background_color": "#199087",}
"coupon_color": "#FFFFFF"
"coupon_color": "#FFFFFF"
"header_color": "#59C65D"
}
}
RESPONSE BODY:
{
"id": <QR_CODE_ID>,
"place_data": {
"id": 1258,
"name": "Montreal, QC, Canada"
},
"tag_data": [],
"meta": {
"notes": ""
},
"campaign": {
"content_type": 10,
"coupon": {
"coupon_code": "ABCD1234",}
"header": "Flat 25% off",
"expires_at": <EXPIRY DATE IN ISO FORMAT>,
"message": "Big sale at Beaconstac stores",
"company_name": "Beaconstac",
"terms_and_conditions": <COUPON T&C>,
"website": "john_doe@example.com",
"description_header": "Big Holiday sale",
"description_body": "Enjoy the biggest holiday sale",
"location": <ADDRESS_URL>,
"website": "https://www.example.com",
"logo_url": <LOGO_URL>,
"customizations": {
"background_color": "#199087",}
"coupon_color": "#FFFFFF"
"coupon_color": "#FFFFFF"
"header_color": "#59C65D"
},
"attributes": {
"color": "#000000",
"margin": 25,
"logoImage": <IMAGE_URL>
},
"url": <QR_CODE_URL>,
"name": "Coupon QR Code",
"state": "A",
"heartbeat": <LAST_DETECTED>,
"created": <CREATED_AT>,
"updated": <UPDATED_AT>,
"qr_type": 1,
"organization": <YOUR_ORG_ID>,
"place": 1258,
"tags": []
}
Create reusable Dynamic Coupon QR Codes to offer customers new coupons without changing the QR Code. Recommended for growing businesses that want to increase sales and increase brand awareness.
SAMPLE QR CODES
![Coupon QR Codes example]( "Coupon QR Codes example")
![Coupon QR Codes example]( "Coupon QR Codes example")
QR Code API for bulk QR Code generation
Generate custom-designed static and dynamic QR Codes in bulk using the QR Code API. Recommended for QR Codes on business cards in bulk, labels, trails, ID cards and product authentication.
**Static bulk QR Codes can only be generated 100 at a time.
Upload a CSV file (default format) and generate thousands of QR Codes in a few minutes.
**Bulk QR Codes via QR Code API downloads in 4 formats - PNG, JPEG, SVG, PDF
Need to test bulk generation for dynamic QR Codes? Talk to us
QR Code API - PARAMETER LIST
Use the QR Code API parameters to generate your QR Codes
Here’s the complete QR Code API documentation
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 Dynamicfields_data object true false Fields data for the QR Code.
Required for Static QR Codes onlycampaign timestamp true false Campaign object.
Required for Dynamic QR Codes onlyorganization 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 listtags 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 integer 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:
![eyeframe square]( "eyeframe square")
circle:
![eyeframe circle]( "eyeframe circle")
rounded:
![eyeframe rounded]( "eyeframe rounded")
left-leaf:
![eyeframe left leaf]( "eyeframe left leaf")
right-leaf:
![eyeframe right leaf]( "eyeframe right leaf")
eyeBallShape string square square:
![eyeball square]( "eyeball square")
circle:
![eyeball circle]( "eyeball circle")
rounded:
![eyeball rounded]( "eyeball rounded")
left-leaf:
![eyeball left leaf]( "eyeball left leaf")
left-diamond:
![eyeball left diamond]( "eyeball left diamond")
right-diamond:
![eyeball right diamond]( "eyeball right diamond")
eyeFrameColor string #000000 Eye Frame color in format #RRGGBB eyeBallColor string #000000 Eye Ball color in format #RRGGBB dataPattern string square square:
![datapattern square]( "datapattern square")
circle:
![datapattern circle]( "datapattern circle")
kite:
![datapattern kite]( "datapattern kite")
left-diamond:
![datapattern left diamond]( "datapattern left diamond")
right-diamond:
![datapattern right diamond]( "datapattern 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 Nonebanner-top:![Top banner frame]( "Top banner frame")
box-top:![Top box frame]( "Top box frame")
box-bottom:![Bottom box frame]( "Bottom box frame")
banner-bottom:![Bottom banner frame]( "Bottom banner frame")
balloon-top:![Top balloon frame]( "Top balloon frame")
balloon-bottom:![Bottom balloon frame]( "Bottom balloon frame")
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 - 0.6] 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
Supported fields: android_url, iphone_url, ipad_url
content_type = 7 (vCard Plus campaigns)
Required fields: first_name, last_name, email, phone(mobile, home, work)
Supported fields: summary, designation, company, customizations(background_color, user_info_color), user_image_url, logo_url, address_line1, address_line1, city, state, zip, country, address_url, website
content_type = 10 (Coupon campaigns)
Required fields: coupon_code, header, message
Supported fields: logo_url, description_header, description_body, customizations, valid_through(day, month, year), website, location, company_name, terms_and_conditions
content_type = 11 (Business Card campaigns)
Required fields: business_name, button_url, button_type, contact(name, phone, email, website)
Supported fields: logo_url, brand_image, website, customizations (button_color), address_url, address, headline, message, open_hours (monday, tuesday, wednesday, thursday, friday, saturday, sunday)
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 string 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. vcard_plus JSON true false Specifies the credentials and contents of the vCard. coupon JSON true false Specifies the credentials and contents of the coupon template. business_card JSON true false Specifies the credentials and contents of the Business Card. QR Code Generator API Features
Customization
Align QR Codes with your branding by adding a frame, color and logo or an image to bolster brand awareness.
Highly scannable
Create QR Codes with the highest level of error correction to make it possible for users to scan your QR Code even if 30% of it is damaged.
Real-time generation
Your QR Codes are created inside your app or website in real-time.
High resolution
5 different formats - PNG, EPS, SVG, JPG, and PDF to help you generate high-quality QR Codes for both the offline and online world.
QR Code API - Use Cases
Employee vCards
Use the QR Code API to create and update employee vCards seamlessly. Whenever new employees join your company, automate vCard QR Code generation for employee identification. Once an employee gets promoted, use the dynamic QR Code API to update their vCard QR Code to reflect their new job role.
Multiple store locations
Let’s say you own a chain of stores across multiple locations. For special discounts and promotions, you’ll need a unique coupon QR Code for each store location. Use the QR Code generator API to generate bulk coupon QR Codes for all your stores. Add your brand logo, change the color scheme, and make them represent your brand throughout. Since these coupons are subject to change, use the dynamic QR Code API to modify your coupon QR Codes instantly.
Feedback collection
You’ll have various surveys and forms for your consumers based on their stage in the consumer buying journey. Integrate the dynamic QR Code generator API into your system to automate the creation and updates of feedback and form QR Codes for your business.
Inventory management
Managing and tracking large shipments can be a hassle. Leverage the QR Code API to generate unique bulk QR Codes for all items in your inventory. Use PDF or plain text QR Codes to store information about each item. Make use of the dynamic QR Code API to update the information easily.
Product packaging
For the CPG industry, product packaging is a crucial aspect that makes or breaks consumers’ purchase decisions. Use the QR Code API to efficiently automate the creation of QR Code campaigns for your product packaging. Whether it’s product information, loyalty programs, or social media engagement, the QR Code API lets you generate QR Codes in a flash. Only a one-time setup is required.
Payments
Conduct safe & secure transactions with the help of payment QR Codes. Use the QR Code payment API to generate QR Codes for grocery stores, retail shops, restaurants, and hospitals for quick & contactless payments. Consumers are either directed to the merchant’s website to complete the transaction or use QR Code UPIs to pay directly from their mobile wallets. Please note that we don’t support QR Code payments, but you can use QR Codes to link users to payment gateways.
CRM
Integrate the QR Code generator API into your CRM software to monitor consumer behavior at every stage of the consumer journey. You can send the data obtained from dynamic QR Codes, such as the number of scans, locations, and devices used to your CRM via a QR Code API call. Save yourself the hassle of switching between two platforms and receive all the data in one place using the dynamic QR Code generator API with your CRM.
FAQs - QR Code API
How do I integrate a QR Code Generator?
Sign up for the API and integrate the code into your app or website to start creating QR Codes automatically. We recommend that you seek the help of a developer to set this up.
Where can I use the QR Code Generator API?
You can use the QR Code generator API in your app or website to create all types of QR Codes to automate vCards for employees, tickets for event attendees, product information for product packaging and more.
How do I make a QR Code with a logo using the API?
You can create a QR Code with a logo using the QR Code generator with logo API.
Can I edit the QR Codes generated using QR Code API?
Absolutely. With the dynamic QR Code API, you can edit and modify your QR Code campaigns at any time. You can also track and measure your campaign’s results from Beaconstac’s analytics dashboard.
Leverage QR Code API to automate QR generation across multiple verticals
![Victor Kong, National Gallery Singapore]( "Victor Kong, National Gallery Singapore")
“Everyone is really happy with the vCard QR Code. Thanks for your fantastic support. We couldn’t have launched our eNamecard in SharePoint Online according to plan if not by your amazing support. We’re looking forward to leverage the scan data on the dashboard to fine-tune the product ”
Victor Kong, Manager (Information & Technology) - National Gallery SingaporeGet started with your free trial
Try our QR Code API and get a hundred requests free. No credit card required. Cancel account anytime.
