# 🚀 Superior Custom QR Code & Dynamic Link Analytics API Welcome to the ultimate QR Code Generation and Tracking Infrastructure. This API is an enterprise-grade, highly scalable layout engine built for developers who need to generate beautiful, brand-compliant QR codes paired with deep analytics insights and dynamic link re-routing. ---

Result Examples

Advanced Themed QR Code Generation Preview

--- ---

The full and up-to-date documentation can be found at: https://qrcode-genie.com/docs

--- ---

🛠️ Quickstart Implementation Guide

## `POST` /v1/qr/generate All parameters must be sent as a JSON object in the request body. #### Core Parameters | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`data`** | String | *Required* | The content you want to encode in your QR Code (e.g., URL or text payload). | | **`size`** | Number | `300` | The horizontal and vertical output canvas dimensions in pixels (minimum `100`). | | **`file_format`** | String | `"svg"` | The output file format container for your graphic. Supported values: `"png"`, `"svg"`, `"jpg"`, `"jpeg"`, `"webp"`, `"pdf"`, `"eps"`, `"tiff"`. | | **`config`** | JSON Object | `{}` | The configuration sub-object defining colors, background textures, alignments, and custom geometries. | --- ### 🎨 Config JSON Object Parameters Customize the structural elements, colors, and styling rules of your matrix canvas using the parameters below: | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`body_type`** | String | `"body0"` | The geometric design style of the internal data matrix modules. See the **Body Matrix Reference** below. | | **`eye_frame`** | String | `"frame10"` | The visual shape of the outer corner markers. See the **Eye Frame Reference** below. | | **`eye_ball`** | String | `"ball0"` | The visual shape of the inner corner marker pixels. See the **Eye Ball Reference** below. | | **`shape_mask`** | String | `null` | Clips the total outer boundary layout of the QR code matrix. See the **Shape Mask Reference** below. | | **`bg_color`** | String | `"#ffffff"` | Background color. Supports 3/6-digit HEX values or `"transparent"`. | | **`body_color`** | String | `"#000000"` | Primary foreground data element color as a HEX value string. | | **`border_color`** | String | `"#000000"` | Structural outer buffer padding zone border color as a HEX value string. | | **`border_width`** | Float | `0.0` | Quiet zone padding width flanking the layout matrix grid. | | **`shadow_effect`** | Boolean | `false` | Toggles soft drop-shadow depth vectors beneath your QR modules. | | **`gradient_type`** | String | `null` | The layout style direction of the color gradient. Value can be `"linear"` or `"radial"`. | | **`gradient_color_1`**| String | `null` | Starting color of the main body element layout gradient as a HEX value. | | **`gradient_color_2`**| String | `null` | Ending color of the main body element layout gradient as a HEX value. | | **`gradient_on_eyes`**| Boolean | `false` | Sets the global gradient across the entire QR graphic, ignoring individual eye colors. | | **`erf1`**| Array| `[]` | Rotate the **upper left eye frame**. Pass an array containing `"fv"` to flip vertically, `"fh"` to flip horizontally, or `["fv", "fh"]` to apply both. | | **`erf2`**| Array| `[]` | Rotate the **upper right eye frame**. Pass an array containing `"fv"` to flip vertically, `"fh"` to flip horizontally, or `["fv", "fh"]` to apply both. | | **`erf3`**| Array| `[]` | Rotate the **bottom left eye frame**. Pass an array containing `"fv"` to flip vertically, `"fh"` to flip horizontally, or `["fv", "fh"]` to apply both. | | **`erf4`**| Array| `[]` | Rotate the **alignment eye frames**. Pass an array containing `"fv"` to flip vertically, `"fh"` to flip horizontally, or `["fv", "fh"]` to apply both. | | **`brf1`**| Array| `[]` | Rotate the **upper left eye ball**. Pass an array containing `"fv"` to flip vertically, `"fh"` to flip horizontally, or `["fv", "fh"]` to apply both. | | **`brf2`**| Array| `[]` | Rotate the **upper right eye ball**. Pass an array containing `"fv"` to flip vertically, `"fh"` to flip horizontally, or `["fv", "fh"]` to apply both. | | **`brf3`**| Array| `[]` | Rotate the **bottom left eye ball**. Pass an array containing `"fv"` to flip vertically, `"fh"` to flip horizontally, or `["fv", "fh"]` to apply both. | | **`brf4`**| Array| `[]` | Rotate the **alignment eye balls**. Pass an array containing `"fv"` to flip vertically, `"fh"` to flip horizontally, or `["fv", "fh"]` to apply both. | | **`logo_url`** | String | `null` | Publicly accessible absolute image URL of the asset to overlay or embed. | | **`logo_mode`** | String | `"default"` | Layout mode for the logo element. Set to `"clean"` to remove background modules behind an overlay, or `"background"` to render a full-bleed backdrop texture. | --- ## 🎛️ Design Geometry Style Reference Tables Mix and match your geometric parameters to generate unique layouts. ### 1. Body Matrix Options (`body_type`) | Preview | Preview | Preview | Preview | Preview | Preview | | :---: | :---: | :---: | :---: | :---: | :---: | |

**`body0`** |

**`body1`** |

**`body2`** |

**`body3`** |

**`body4`** |

**`body5`** | |

**`body6`** |

**`body7`** |

**`body8`** |

**`body9`** |

**`body10`** |

**`body11`** | |

**`body12`** |

**`body13`** |

**`body14`** |

**`body15`** |

**`body16`** |

**`body17`** | |

**`body18`** |

**`body19`** |

**`body20`** |

**`body21`** | | | | | | | | | ### 2. Outer Eye Frames (`eye_frame`) | Preview | Preview | Preview | Preview | Preview | Preview | | :---: | :---: | :---: | :---: | :---: | :---: | |

**`frame0`** |

**`frame1`** |

**`frame2`** |

**`frame3`** |

**`frame4`** |

**`frame5`** | |

**`frame6`** |

**`frame7`** |

**`frame8`** |

**`frame9`** |

**`frame10`** |

**`frame11`** | |

**`frame12`** |

**`frame13`** |

**`frame14`** |

**`frame15`** | | | ### 3. Inner Eye Balls (`eye_ball`) | Preview | Preview | Preview | Preview | Preview | Preview | | :---: | :---: | :---: | :---: | :---: | :---: | |

**`ball0`** |

**`ball1`** |

**`ball2`** |

**`ball3`** |

**`ball4`** |

**`ball5`** | |

**`ball6`** |

**`ball7`** |

**`ball8`** |

**`ball9`** |

**`ball10`** |

**`ball11`** | |

**`ball12`** |

**`ball13`** |

**`ball14`** |

**`mask0`** |

**`mask1`** |

**`mask2`** |

**`mask3`** | |

**`mask4`** |

**`mask5`** |

**`mask6`** |

**`mask7`** | |

**`mask8`** |

**`mask9`** |

**`mask10`** |

**`mask11`** | |

**`mask12`** |

**`mask13`** |

**`mask14`** |

**`mask15`** | |

**`mask16`** |

**`mask17`** |

**`mask18`** |

**`mask19`** | |

**`mask20`** |

**`mask21`** |

**`mask22`** |

**`mask23`** | |

**`mask24`** |

**`mask25`** |

**`mask26`** |

**`mask27`** | |

**`mask28`** |

**`mask29`** |

**`mask30`** |

**`mask31`** | |

**`mask32`** |

**`mask33`** |

**`mask34`** |

**`mask35`** | --- ## 🚀 Design Blueprints & Visual Results ### Advanced Themed Blueprint (e.g., Character / Graphic Theme) Generate highly immersive, branded artwork QR codes featuring custom background overlays and matching geometries: #### Example Request Body Payload: ```json { "data": "QR Code Genie by Yaziris", "size": 500, "file_format": "png", "config": { "body_type": "body6", "eye_frame": "frame9", "eye_ball": "ball9", "colors": { "bg_color": "#ffffff", "body_color": "#000000", "border_color": "#000000", "gradient_type": "linear", "gradient_color_1": "#0b00db", "gradient_color_2": "#d60000", "gradient_on_eyes": true }, "border_width": 0.3, "shadow_effect": false, "shape_mask": "mask1", "logo": { "logo_url": "https://res.cloudinary.com/du9ifg5n8/image/upload/v1782683506/image_4758ebd9_tiexbw.png", "logo_mode": "background" } } } ```

Example Code Result Response

Advanced Character Themed QR Code Generation Preview

--- --- ---

📦 Bulk QR Code Generation

## `POST` /v1/qr/bulk Creates an asynchronous processing task to generate multiple custom QR codes in a single batch request. #### Core Parameters | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`items`** | Array\<Object\> | *Required* | An array containing the payloads and item-specific parameters for each individual QR code. Must contain at least `1` item. See schema details below. | | **`size`** | Integer | `300` | The canvas dimensions in pixels. Allowed range: `100` to `2000`. | | **`file_format`** | String | `"svg"` | The output file format container. Supported values: `"png"`, `"svg"`, `"pdf"`, `"eps"`. | | **`global_config`** | Object \| Null | `null` | A configuration object applying baseline styling rules to all batch elements if not overridden inside `items`. | #### Items Object Attributes | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`data`** | String | *Required* | The content you want to encode in this specific QR Code (e.g., URL or text payload). | | **`filename`** | String \| Null | `null` | The custom file title assigned to this asset inside the final downloaded package archive bundle. | | **`config`** | Object \| Null | `null` | Item-specific configuration sub-object defining colors and alignments. Overrides properties set in `global_config`. | --- ## `GET` /v1/qr/bulk/status/{task_id} Retrieves the current execution state, item progress percentage, and generation metrics of a running batch task. #### Path Parameters | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`task_id`** | String | *Required* | The unique string returned by the bulk creation endpoint used to track job execution state. | --- ## `GET` /v1/qr/bulk/download/{task_id} Fetches a compiled compressed archive package (`.zip`) containing all successfully generated graphics for completed batches. #### Path Parameters | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`task_id`** | String | *Required* | The unique identifier of the finalized execution job you wish to pull data assets from. | --- --- ---

🔀 Dynamic Redirection Links

## `POST` /v1/qr/dynamic Creates a dynamic short link that tracks scan metrics and allows real-time destination URL updates without altering the printed QR code pattern matrix. #### Core Parameters | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`destination_url`** | String | *Required* | The primary target URL where visitors are instantly redirected upon parsing the short link asset. | | **`tags`** | Array\<String\> | `[]` | Categorization or grouping strings assigned to this asset for simplified collection filtering. | | **`expires_at`** | String \| Null | `null` | ISO 8601 datetime token string defining the absolute lifespan boundary limit for routing validation rules. | | **`custom_domain`** | String \| Null | `null` | An alternative branded base path URL mask string utilized rather than default routing infrastructure prefixes. | --- ## `PATCH` /v1/qr/dynamic/{short_key} Updates the tracking parameters, destination routing target logic, or baseline validation state properties of an active short link. #### Path Parameters | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`short_key`** | String | *Required* | The unique string string index key representing your dynamic routing target record. | #### Body Parameters | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`destination_url`** | String \| Null | `null` | The updated destination routing path target to push future scanning traffic towards. | | **`tags`** | Array\<String\> \| Null | `null` | Revised tracking collections array mapping schema string flags. Overwrites existing dataset assignments. | | **`expires_at`** | String \| Null | `null` | Updated expiration datetime stamp window logic parameters for short path execution. | | **`custom_domain`** | String \| Null | `null` | The revised custom base host prefix domain ruleset applied to this specific target map profile. | | **`is_active`** | Boolean \| Null | `null` | Toggle state flag string control variable toggling live routing behavior processing. (Setting this to `false` deactivates the link without deleting it or its scan history records).| --- ## `DELETE` /v1/qr/dynamic/{short_key} Permanently removes a short link mapping, disabling validation behavior routes and deleting all its scan analytics history. #### Path Parameters | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`short_key`** | String | *Required* | The distinct short path token record string designated for deletion. | --- ## `GET` /v1/qr/dynamic/{short_key}/stats Retrieves tracking analytics metrics details for a specific dynamic routing identifier. #### Path Parameters | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`short_key`** | String | *Required* | The unique link identifier to pull the scan stats analytics for. | --- ## `GET` /v1/qr/dynamic/{short_key}/time-series Fetches historical scan tracking telemetry datasets distributed over daily calendar grid framework layout. #### Path Parameters | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`short_key`** | String | *Required* | The target tracking short routing key token string to pull metrics for. | #### Query Parameters | Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | **`days`** | Integer | `30` | The lookback window horizon size calculation boundary limit constraint. Allowed range: `7` to `365`. | ---

The full and up-to-date documentation can be found at: https://qrcode-genie.com/docs

--- ---