QR Code Reader
Reads a QR code from an image and returns the text it encodes.
Content-Type: application/json
Headers
| Header | Type | Required | Description |
|---|---|---|---|
key | string | Yes | API key issued for authentication. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | Unique ID you assign to correlate the request with the response. |
image | string | Yes | Base64 string / data URI of the image containing the QR code. |
Example
POST/pcs/QR-Reader
curl --location 'https://sandbox/pcs/QR-Reader' \
--header 'key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"recordId": "1",
"image": "data:image/jpeg;base64,<BASE64_STRING>"
}'200
"text-within-qr-code"Response
200 OK returns the decoded text as a JSON string — the raw content encoded in the QR
code, with no wrapping object.
Error handling
200 on success, 422 on a validation error — see
Error handling for the common error shape.