Create QR Code

This action creates a QR code or other two-dimensional (2D) code image in the specified format. It supports various 2D code types and allows for customization of size, colors, and other properties.

Parameters

Required

• Data (string) - The data to be encoded in the QR code.
• CodeType (enum) - The type of 2D code to generate. Default: QrCode. Options include:
  • QrCode - Standard QR code format
  • DataMatrix - Compact 2D code used in industrial applications
  • Aztec - Space-efficient 2D code used in transportation
  • Pdf417 - Stacked linear barcode format
  • Maxicode - High-capacity 2D code used by shipping services

Optional

• OutputImageFormat (enum) - The format of the output image. Default: Png. Options include:

  • Png - PNG format
  • Jpeg - JPEG format
  • Gif - GIF format
  • Svg - SVG format
  • Tiff - TIFF format

• Height (integer) - The height of the QR code image in pixels. Default: 290

• Width (integer) - The width of the QR code image in pixels. Default: 120

• BackgroundColorAsString (string) - The background color of the QR code. Default: White

• Rotation (float) - Rotation angle in degrees. Default: 0

• BorderVisible (boolean) - Whether to display a border. Default: false

• BorderColorAsString (string) - The border color (when border is visible)

• BorderStyle (enum) - Style of the border. Default: Solid. Options include: Solid, Dashed, Dotted

• BorderWidth (integer) - Width of the border in pixels. Default: 1

Output

• FileContent (string) - Base64-encoded string of the QR code image
• Filename (string) - Suggested filename for the QR code image

Example

{
  "Data": "https://docs.uflow.dev",
  "CodeType": "QrCode",
  "OutputImageFormat": "Png",
  "Height": 300,
  "Width": 300,
  "BackgroundColorAsString": "#FFFFFF"
}

Notes

Credit Cost

Cost: 1 credit(s) per call

• QR codes can store various types of data including URLs, text, contact information, WiFi credentials, and more.
• Different 2D code types have different data capacities and encoding characteristics.
• For optimal scanning results, ensure sufficient contrast between the foreground and background colors.
• When using color parameters, you can provide either named colors (e.g., “Red”, “Blue”) or hex color values (e.g., “#FF0000”, “#0000FF”).