| Black & white | Colored | With frames | With logo | Background image | |
|---|---|---|---|---|---|
| Static | 
|
|
|
|
|
| Dynamic |
|
|
|
|
|
| In Bulk |
|
|
|
|
|
Whether you are looking to integrate the QR Code generator API with your Android, iOS system or your workflow, it takes just 15 mins!
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>' \
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.
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
},
}
}
{
"meta": {
},
"place_data": {
},
"fields_data": {
},
"campaign": null,"attributes": {
},
"url": <QR_CODE_URL>,}
Create black-and-white QR Codes that have a fixed URL behind it. Once printed, the link behind the QR Code cannot be changed
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
"attributes": {
},
"campaign": {
}
}
{
"meta": {
},
"place_data": {
},
"campaign": {
},
"fields_data": {},"attributes": {
}
"url": <QR_CODE_URL>,}
Create black-and-white QR Codes which have the flexibility to rotate, modify or schedule campaigns (URLs) linked to them
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.
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
"attributes": {
},
}
}
{
"place_data": {
},
"tag_data": [],"meta": {
},
"fields_data": {
},
"campaign": null,"attributes": {
},
"url": <QR_CODE_URL>,}
Create a colored QR Code with a fixed URL. Useful for an event pass or corporate presentations
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
"attributes": {
},
"campaign": {
}
}
{
"meta": {
},
"place_data": {
},
"campaign": {
},
"fields_data": {},"attributes": {
}
"url": <QR_CODE_URL>,}
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
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.
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
"attributes": {
},
}
}
{
"meta": {
},
"place_data": {
},
"fields_data": {
},
"campaign": null,"attributes": {
},
"url": <QR_CODE_URL>,}
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.
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
"attributes": {
},
"campaign": {
}
}
{
"meta": {
},
"place_data": {
},
"campaign": {
},
"fields_data": {},"attributes": {
},
"url": <QR_CODE_URL>,}
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.
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.
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
"attributes": {
},
}
}
{
"place_data": {
},
"tag_data": [],"meta": {
},
"fields_data": {
},
"campaign": null,"attributes": {
},
"url": <QR_CODE_URL>,}
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.
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
"attributes": {
},
"campaign": {
}
}
{
"meta": {
},
"place_data": {
},
"campaign": {
},
"fields_data": {},"attributes": {
}
"url": <QR_CODE_URL>,}
Create branded QR Codes with logo. Rotate campaigns (URL) linked to the QR Code. Recommended for F&B campaigns, cosmetic brands and more.
Create vCard QR Codes to allow anyone to add your contact information instantly. Place these on business cards, brochures or flyers for easy access.
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
"attributes": {
},
"phone": {
}
}
{
"place_data": {
},
"tag_data": [],"meta": {
},
"fields_data": {
"phone": {
},
"campaign": null,"attributes": {
},
"url": <QR_CODE_URL>,}
Create non-editable Static vCard QR Codes for one-time use at a conference, meeting or a seminar.
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
"attributes": {
},
"campaign": {
"vcard_plus": {
"phone": {
"customizations": {
}
}
{
"meta": {
},
"place_data": {
},
"campaign": {
"vcard_plus": {
"phone": {
"customizations": {
},
"fields_data": {},"attributes": {
}
"url": <QR_CODE_URL>,}
Create editable Dynamic vCard QR Codes for employee details or long-term use that you can edit in real-time and as frequently as needed.
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
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
"attributes": {
},
"campaign": {
"business_card": {
"open_hours": {
"monday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"tuesday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"wednesday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"thursday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"friday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"saturday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"sunday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"customizations": {
"contact": {
}
}
{
"place_data": {
},
"tag_data": [],"meta": {
},
"campaign": {
"business_card": {
"open_hours": {
"monday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"tuesday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"wednesday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"thursday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"friday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"saturday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"sunday": {
"opens": {
"closes": {
"is_closed": <BOOLEAN>
"customizations": {
"contact": {
}
"attributes": {
},
"url": <QR_CODE_URL>,}
Create branded Dynamic QR Codes for your business cards that you can edit, update or switch URLs based on analytics. Recommended for SMBs and enterprises to increase brand awareness and generate leads.
Make Coupon QR Codes to offer discounts and deals to your consumers to 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
https://api.beaconstac.com/api/2.0/qrcodes/
POST
Authorization: Token <YOUR_TOKEN>
Content-Type: application/json
{
"attributes": {
},
"campaign": {
"coupon": {
"customizations": {
}
}
{
"place_data": {
},
"tag_data": [],"meta": {
},
"campaign": {
"coupon": {
"customizations": {
},
"attributes": {
},
"url": <QR_CODE_URL>,}
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.
| 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 - 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 |
| 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. |
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.
Try our QR Code API and get a hundred requests free. No credit card required. Cancel account anytime.
CONTACT
USA
450 Lexington Avenue, 4th Floor
New York, NY 10017
+1 (646) 968 0378
INDIA
29, MG Road, Bengaluru
Karnataka 560001
support@beaconstac.com
CONNECT WITH US
MOBILE APPS
NEARBEE
CHROME EXTENSION
