Scan QR Code API

How it works

1. The source file is passed to the converter and API scans for QR codes.
2. Each detected QR code is decoded.
3. Results are returned as a JSON array, where each object represents one detected QR code.

How to perform the conversion

You can call the converter via a standard HTTP POST request. Below is an example using curl:

curl -X POST "https://v2.convertapi.com/convert/qrcode/to/data" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "File=@/path/to/your/file.pdf" \
  -F "StoreFile=true"

Output JSON

The QR code data is returned as a JSON file in the API response.

After conversion, the API returns a standard ConvertAPI response containing a Files array.
Each file entry includes a Url where you can download the generated JSON file.

API response example

{
  "ConversionCost": 1,
  "Files": [
    {
      "FileName": "QRCode.json",
      "FileExt": "json",
      "FileSize": 584,
      "FileId": "jesmx8nz3ax37psd99ch6jjhuwwvfj31",
      "Url": "https://v2.convertapi.com/d/jesmx8nz3ax34psd88ch6jjhuwwvfj12/QrCode.json"
    }
  ]
}

Downloaded JSON file content

The downloaded JSON file contains the actual QR code detection results:

[
  {
    "Text": "https://www.convertapi.com",
    "Format": "QRCode",
    "RawBytes": "QaaHR0cHM6Ly93d3cuY29udmVydGFwaS5jb20OwR7BHsEQ==",
    "Metadata": {
      "QrMaskPattern": "6",
      "ErrorCorrectionLevel": "L",
      "ErrorsCorrected": "0",
      "SymbologyIdentifier": "]Q1",
      "Orientation": "0"
    },
    "Points": [
      {
        "X": 120,
        "Y": 480
      },
      {
        "X": 120,
        "Y": 120
      },
      {
        "X": 480,
        "Y": 120
      },
      {
        "X": 420,
        "Y": 420
      }
    ]
  }
]

If multiple QR codes are found, the array contains multiple objects.

Field reference

Text - The decoded human-readable QR code value.

This is usually the main field your application will consume. For example, it may contain a URL, identifier, payload, or encoded data embedded in the QR code.

Format - The detected barcode format.

For this converter, the value will always be QRCode.

RawBytes - Base64-encoded raw bytes returned by the decoder.

This field is useful when you need access to the original decoded byte payload, not just the text representation. It is not guaranteed to be present for every QR code.

Metadata - Additional decoder-provided information about the detected QR code.

The exact fields may vary depending on what information is available for the detected symbol.

Metadata fields include:

• QrMaskPattern
• SymbologyIdentifier
• Orientation
• ErrorCorrectionLevel
• ErrorsCorrected

Because metadata is format-dependent, client code should treat this object as extensible and avoid assuming that every field is always present.

Points - Coordinates describing where the QR code was detected in the source image or page.

Each point contains:

• X
• Y

QR codes typically return 4 points.

Summary

The Scan QR Code API returns a clean, developer-friendly JSON structure.