Scanner

Scanner endpoints allow you to scan QR codes from images.

Scan QR Code

Scan a QR code from an uploaded image file.

POST https://v1.freeqr.io/api/scan

Requires Authentication: No

Request Body (POST)

Content-Type: image/png, image/jpeg, image/webp, or application/octet-stream

Send the image file directly as the raw request body (binary).

Item	Required	Description
Request body	Yes	Raw image binary data
Content-Type header	Yes	MIME type of the uploaded image

Note: Do not wrap the file in multipart/form-data and do not send JSON.

Example Request

curl -X POST "https://v1.freeqr.io/api/scan" \
  -H "Content-Type: image/png" \
  --data-binary @./qr.png

Response

{
  "data": {
    "text": "https://example.com/page"
  }
}

Response Fields

Field	Type	Description
data.text	string	Decoded QR code text content

Error Response

If no QR code is found or the image is invalid:

{
  "message": "Invalid request."
}

Note: If SCANNER_ENDPOINT is configured, the request may be forwarded to an external scanner service.