API docs

Style Reference

The full set of valid values for config on /v1/qr/generate and qr_config on dynamic links.

QRConfig fields

body_typestring enumdefault: body0

Structural style of the data matrix modules.

eye_framestring enumdefault: frame10

Style of the three outer corner finder patterns.

eye_ballstring enumdefault: ball0

Style of the inner pixels inside each corner frame.

shape_maskstring enum, nullabledefault: null

Clips the whole QR block into a decorative outline.

border_widthnumber ≥ 0default: 0.0

Border width flanking the layout matrix.

shadow_effectbooleandefault: false

Applies a soft 3D drop-shadow.

colorsColorsConfig objectdefault: —

See Colors below.

logoLogoConfig object, nullabledefault: null

Overlay a brand logo in the center or as a background.

body_type

The shape of the individual data modules.

body0Square

body1Circle

body2Rounded

body3Extra Rounded

body4Diamond

body5Star

body6Dots

body7Edge Cut

body8Edge Cut Smooth

body9Pointed

body10Pointed Smooth

body11Pointed In

body12Pointed In Smooth

body13Rounded In

body14Rounded In Smooth

body15Rounded Pointed

body16Circular

body17Zebra

body18Zebra Vertical

body19Teardrop

body20Wavy

body21Heart

eye_frame

The outer shape of each of the three finder patterns.

frame0Rounded Square

frame1Extra Rounded Square

frame2Octagon

frame3Wavy Circle

frame4Teardrop

frame5Leaf

frame6Dashed

frame7Dome

frame8Hexagon

frame9Circle

frame10Square

frame11Dented Square

frame12Double Dented Square

frame13Dotted

frame14Stars

frame15Hearts

eye_ball

The inner shape inside each finder pattern.

ball0Square

ball1Rounded Square

ball2Extra Rounded

ball3Circle

ball4Hexagon

ball5Star

ball6Leaf

ball7Scalloped Flower

ball8Sunny

ball9Oval

ball10Diamond

ball11Heart

ball12Octagon

ball13Weed

ball14Shield

ball15Wavy Square

shape_mask

Clips the entire QR code into a decorative outline.

mask0Square

mask1Circle

mask2Heart

mask3Hexagon

mask4Cloud

mask5Sunny

mask6Star

mask7Wavy Circle

mask8Octagon

mask9Speech Bubble

mask10Water Drop

mask11Egg

mask12Shield

mask13Location Pin

mask14Cross

mask15Hospital

mask16House

mask17T-Shirt

mask18Gift Box

mask19Birthday Cake

mask20Light Bulb

mask21Coffee Mug

mask22Shopping Cart

mask23French Fries

mask24Camera

mask25Paw Print

mask26Fox Face

mask27Cat Face

mask28Dog Face

mask29Weed

mask30Book

mask31Airplane

mask32Car

mask33Bike

mask34Truck

mask35Thumbs Up

Colors

bg_color#ffffff

Background canvas color. HEX or 'transparent'.

body_color#000000

Primary module color. HEX or 'transparent'.

border_color#4a90e2

Outer border color. HEX or 'transparent'.

gradient_typelinear

'linear' or 'radial'.

gradient_color_1 / gradient_color_2#ff5733 → #c70039

Gradient start/end colors.

gradient_on_eyesfalse

Whether the gradient also spans the eye elements.

eye_frame_color_1–4#ff0000

Per-corner eye frame color overrides.

eye_ball_color_1–4#111111

Per-corner eye ball color overrides.

erf1–4["fh", "fv"]

Per-corner eye frame flip. Can Flip Horizontally, Vertically, or both.

brf1–4["fh", "fv"]

Per-corner eye ball flip. Can Flip Horizontally, Vertically, or both.

Example config

{
  "body_type": "body2",
  "eye_frame": "frame3",
  "eye_ball": "ball5",
  "shape_mask": null,
  "border_width": 0,
  "shadow_effect": false,
  "colors": {
    "bg_color": "#ffffff",
    "body_color": "#4F46E5",
    "gradient_type": "linear",
    "gradient_color_1": "#4F46E5",
    "gradient_color_2": "#06B6D4",
    "gradient_on_eyes": true,
    "erf2": [
      "fh"
    ],
    "erf3": [
      "fv"
    ],
    "erf4": [
      "fh",
      "fv"
    ]
  }
}