Create QR Code

POST

qr-codes

curl --request POST \
  --url https://api.useqrkit.com/v1/qr-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "gs1",
  "mode": "dynamic",
  "name": "Cocoa 200g",
  "primary_key": {
    "ai": "01",
    "value": "09506000134352"
  },
  "qualifiers": [
    {
      "ai": "10",
      "value": "LOT1"
    }
  ],
  "attributes": {
    "17": "270601"
  },
  "destination": "https://brand.example/products/cocoa-200g",
  "links": [
    {
      "linkType": "gs1:pip",
      "href": "https://brand.example/products/cocoa-200g",
      "title": "Product information",
      "hreflang": [
        "en"
      ]
    },
    {
      "linkType": "gs1:instructions",
      "href": "https://brand.example/products/cocoa-200g/how-to",
      "title": "How to use"
    }
  ],
  "overrides": [
    {
      "path": "10/LOT1",
      "href": "https://brand.example/recalls/2026-07"
    }
  ]
}
'

{
  "id": "qr_123",
  "object": "qr_code",
  "kind": "dynamic",
  "name": "<string>",
  "type": "url",
  "short_code": "AB3D5",
  "short_url": "https://scan.useqrkit.com/AB3D5",
  "gs1": {
    "mode": "static",
    "key": "01/09506000134352/10/LOT1",
    "digital_link": "<string>",
    "primary_key": {
      "ai": "<string>",
      "value": "<string>"
    },
    "qualifiers": [
      {
        "ai": "<string>",
        "value": "<string>"
      }
    ],
    "attributes": {},
    "links": [
      {
        "linkType": "gs1:pip",
        "href": "<string>",
        "title": "<string>",
        "hreflang": [
          "<string>"
        ],
        "type": "<string>",
        "context": [
          "<string>"
        ]
      }
    ],
    "overrides": [
      {
        "path": "10/LOT1",
        "href": "<string>",
        "links": [
          {
            "linkType": "gs1:pip",
            "href": "<string>",
            "title": "<string>",
            "hreflang": [
              "<string>"
            ],
            "type": "<string>",
            "context": [
              "<string>"
            ]
          }
        ]
      }
    ],
    "linkset_url": "https://api.useqrkit.com/v1/qr-codes/qr_123/linkset"
  },
  "target": {
    "type": "<string>",
    "destination": "<string>",
    "editable": true,
    "summary": {
      "title": "<string>",
      "menus": 123,
      "items": 123
    }
  },
  "design": {
    "colors": {
      "foreground": "<string>",
      "background": "<string>"
    },
    "gradient": {
      "start": "<string>",
      "end": "<string>",
      "type": "<string>"
    },
    "shapes": {
      "body": "<string>",
      "eye_frame": "<string>",
      "eye_ball": "<string>"
    },
    "eye_colors": {
      "frame": "<string>",
      "ball": "<string>"
    },
    "has_logo": true,
    "transparent_background": true
  },
  "folder_id": "fld_12",
  "tags": [
    "<string>"
  ],
  "image_url": "https://img.useqrkit.com/qr-AB3D5-1717000000000.svg",
  "download_url": "/v1/qr-codes/qr_123/download",
  "is_active": true,
  "scan_count": 123,
  "utm": {
    "source": "<string>",
    "medium": "<string>",
    "campaign": "<string>",
    "term": "<string>",
    "content": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

API key in the Authorization header: Bearer qr_live_… or Bearer qr_test_…. Token endpoints take a Clerk session JWT instead.

Body

application/json

Option 1
Option 2

target

object

required

What the QR code points to. Each type takes structured fields, or a pre-encoded destination string if you prefer to encode yourself.

Show child attributes

name

string

Defaults to "Campaign {code}" / "Static {code}".

Maximum string length: 255

type

enum<string>

Chooses the mode where the type allows it. url defaults to dynamic; wifi/text/email/sms/event default to static but accept dynamic (hosted scan page, editable, scan analytics — requires structured target fields, not a pre-encoded destination); vcard always dynamic. Omit to use the type's default.

Available options:

dynamic,

static

design

object

Visual customization. Stored with the code, so the dashboard shows exactly what the API created.

Show child attributes

folder_id

string

Folder to place the code in (e.g. fld_12).

Response

QR code created

string

qr_… for dynamic, sqr_… for static.

Example:

"qr_123"

object

string

Example:

"qr_code"

kind

enum<string>

Available options:

dynamic,

static

name

string

type

enum<string>

Available options:

url,

text,

email,

sms,

wifi,

event,

vcard,

gs1

short_code

string

Example:

"AB3D5"

short_url

string | null

null for static codes. For a dynamic GS1 code this is the Digital Link URI itself, not <host>/<short_code>.

Example:

"https://scan.useqrkit.com/AB3D5"

gs1

object

Present on GS1 codes only. The identifier half is READ-ONLY (R4 — it is printed); links and overrides are the editable half.

Show child attributes

target

object

Show child attributes

design

object | null

Show child attributes

folder_id

string | null

Example:

"fld_12"

tags

string[]

image_url

string

Example:

"https://img.useqrkit.com/qr-AB3D5-1717000000000.svg"

download_url

string

Example:

"/v1/qr-codes/qr_123/download"

is_active

boolean

scan_count

integer | null

null for static codes (no tracking).

utm

object | null

UTM parameters (null unless set on a dynamic url code).

Show child attributes

created_at

string<date-time>

updated_at

string<date-time>

curl --request POST \
  --url https://api.useqrkit.com/v1/qr-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "gs1",
  "mode": "dynamic",
  "name": "Cocoa 200g",
  "primary_key": {
    "ai": "01",
    "value": "09506000134352"
  },
  "qualifiers": [
    {
      "ai": "10",
      "value": "LOT1"
    }
  ],
  "attributes": {
    "17": "270601"
  },
  "destination": "https://brand.example/products/cocoa-200g",
  "links": [
    {
      "linkType": "gs1:pip",
      "href": "https://brand.example/products/cocoa-200g",
      "title": "Product information",
      "hreflang": [
        "en"
      ]
    },
    {
      "linkType": "gs1:instructions",
      "href": "https://brand.example/products/cocoa-200g/how-to",
      "title": "How to use"
    }
  ],
  "overrides": [
    {
      "path": "10/LOT1",
      "href": "https://brand.example/recalls/2026-07"
    }
  ]
}
'

{
  "id": "qr_123",
  "object": "qr_code",
  "kind": "dynamic",
  "name": "<string>",
  "type": "url",
  "short_code": "AB3D5",
  "short_url": "https://scan.useqrkit.com/AB3D5",
  "gs1": {
    "mode": "static",
    "key": "01/09506000134352/10/LOT1",
    "digital_link": "<string>",
    "primary_key": {
      "ai": "<string>",
      "value": "<string>"
    },
    "qualifiers": [
      {
        "ai": "<string>",
        "value": "<string>"
      }
    ],
    "attributes": {},
    "links": [
      {
        "linkType": "gs1:pip",
        "href": "<string>",
        "title": "<string>",
        "hreflang": [
          "<string>"
        ],
        "type": "<string>",
        "context": [
          "<string>"
        ]
      }
    ],
    "overrides": [
      {
        "path": "10/LOT1",
        "href": "<string>",
        "links": [
          {
            "linkType": "gs1:pip",
            "href": "<string>",
            "title": "<string>",
            "hreflang": [
              "<string>"
            ],
            "type": "<string>",
            "context": [
              "<string>"
            ]
          }
        ]
      }
    ],
    "linkset_url": "https://api.useqrkit.com/v1/qr-codes/qr_123/linkset"
  },
  "target": {
    "type": "<string>",
    "destination": "<string>",
    "editable": true,
    "summary": {
      "title": "<string>",
      "menus": 123,
      "items": 123
    }
  },
  "design": {
    "colors": {
      "foreground": "<string>",
      "background": "<string>"
    },
    "gradient": {
      "start": "<string>",
      "end": "<string>",
      "type": "<string>"
    },
    "shapes": {
      "body": "<string>",
      "eye_frame": "<string>",
      "eye_ball": "<string>"
    },
    "eye_colors": {
      "frame": "<string>",
      "ball": "<string>"
    },
    "has_logo": true,
    "transparent_background": true
  },
  "folder_id": "fld_12",
  "tags": [
    "<string>"
  ],
  "image_url": "https://img.useqrkit.com/qr-AB3D5-1717000000000.svg",
  "download_url": "/v1/qr-codes/qr_123/download",
  "is_active": true,
  "scan_count": 123,
  "utm": {
    "source": "<string>",
    "medium": "<string>",
    "campaign": "<string>",
    "term": "<string>",
    "content": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

Overview

QR Codes

Batches

Folders

Tokens

Account

QR Codes

Batches

Folders

Tokens

Webhooks

Events

Authorizations

Body

Response