Scanner

Scanner endpoints allow you to scan QR codes from images.

Scan QR Code

Scan a QR code from an uploaded image, URL, or data URL.

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

Requires Authentication: No

Query Parameters (GET)

Parameter	Type	Required	Description
url	string (URL)	No	URL of the image to scan (max 4096 characters)

Request Body (POST)

Content-Type: application/json or multipart/form-data

Parameter	Type	Required	Description
url	string (URL)	No	URL of the image to scan (max 4096 characters)
data_url	string	No	Base64 data URL of the image (max 5MB)
image	string	No	File key/reference (max 255 characters, must be valid image)

Note: At least one of url, data_url, or image must be provided.

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.