Scan API

This API finds and decodes 1D and 2D barcodes on any images sent to it.

Main features

• Accepts .JPG, .PNG, .BMP and .GIF images.
• Can scan multiple codes within one picture as well as determine a type of each code.
• Scans multiple types of widely used 1D and 2D barcodes.
• Returns values as well as Base64-encoded values allowing for the extraction of binary data from barcodes.

Supported code types

Our API accepts types in case insensitive manner and can scan multiple codes of different types in a single image.

To denote multiple types recognition just send them in a string separated by commas like so: “code-128,QR-CODE,eAn-13”.

1D-Product	1D-Industrial	2D
UPC-A	CODE-39	PDF417
UPC-E	CODE-128	AZTEC
EAN-8	INDUSTRIAL-25	DATAMATRIX
EAN-13		QR-CODE

Image format options

You can send images using the following ways in order of priority:

• Image URL
• Base64 encoded image
• Direct upload (binary form)

Examples

Each example has a link to a full picture, as well as the scan result.

{
  "time": 1.65,
  "result": [
    {
      "value": "t=20210826T173000&s=129.99&fn=9280440301247726&i=86272&fp=3825511704&n=1",
      "valuebase64": "dD0yMDIxMDgyNlQxNzMwMDAmcz0xMjkuOTkmZm49OTI4MDQ0MDMwMTI0NzcyNiZpPTg2MjcyJmZwPTM4MjU1MTE3MDQmbj0x",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

{
  "time": 0.772,
  "result": [
    {
      "value": "t=20200915T2019&s=177.38&fn=9280440300268736&i=56223&fp=2542966661&n=1",
      "valuebase64": "dD0yMDIwMDkxNVQyMDE5JnM9MTc3LjM4JmZuPTkyODA0NDAzMDAyNjg3MzYmaT01NjIyMyZmcD0yNTQyOTY2NjYxJm49MQ==",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

{
  "time": 0.965,
  "result": [
    {
      "value": "t=20200915T2019&s=177.38&fn=9280440300268736&i=56223&fp=2542966661&n=1",
      "valuebase64": "dD0yMDIwMDkxNVQyMDE5JnM9MTc3LjM4JmZuPTkyODA0NDAzMDAyNjg3MzYmaT01NjIyMyZmcD0yNTQyOTY2NjYxJm49MQ==",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

{
  "time": 0.964,
  "result": [
    {
      "value": "t=20200908T2104&s=1035.92&fn=9280440300268646&i=78812&fp=2533948140&n=1",
      "valuebase64": "dD0yMDIwMDkwOFQyMTA0JnM9MTAzNS45MiZmbj05MjgwNDQwMzAwMjY4NjQ2Jmk9Nzg4MTImZnA9MjUzMzk0ODE0MCZuPTE=",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

{
  "time": 1.38,
  "result": [
    {
      "value": "t=20200908T2104&s=1035.92&fn=9280440300268646&i=78812&fp=2533948140&n=1",
      "valuebase64": "dD0yMDIwMDkwOFQyMTA0JnM9MTAzNS45MiZmbj05MjgwNDQwMzAwMjY4NjQ2Jmk9Nzg4MTImZnA9MjUzMzk0ODE0MCZuPTE=",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

{
  "time": 0.146,
  "result": [
    {
      "value": "t=20200903T2143&s=71.98&fn=9289000100446915&i=93801&fp=796409561&n=1",
      "valuebase64": "dD0yMDIwMDkwM1QyMTQzJnM9NzEuOTgmZm49OTI4OTAwMDEwMDQ0NjkxNSZpPTkzODAxJmZwPTc5NjQwOTU2MSZuPTE=",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

{
  "time": 0.151,
  "result": [
    {
      "value": "t=20200903T2141&s=311.76&fn=9289000100516140&i=68816&fp=1138494099&n=1",
      "valuebase64": "dD0yMDIwMDkwM1QyMTQxJnM9MzExLjc2JmZuPTkyODkwMDAxMDA1MTYxNDAmaT02ODgxNiZmcD0xMTM4NDk0MDk5Jm49MQ==",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

{
  "time": 0.433,
  "result": [
    {
      "value": "t=20200903T2141&s=227.97&fn=9289000100516140&i=68815&fp=3135394266&n=1",
      "valuebase64": "dD0yMDIwMDkwM1QyMTQxJnM9MjI3Ljk3JmZuPTkyODkwMDAxMDA1MTYxNDAmaT02ODgxNSZmcD0zMTM1Mzk0MjY2Jm49MQ==",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

{
  "time": 0.943,
  "result": [
    {
      "value": "t=20211011T151600&s=743.52&fn=9280440300899190&i=168309&fp=2568350898&n=1",
      "valuebase64": "dD0yMDIxMTAxMVQxNTE2MDAmcz03NDMuNTImZm49OTI4MDQ0MDMwMDg5OTE5MCZpPTE2ODMwOSZmcD0yNTY4MzUwODk4Jm49MQ==",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

{
  "time": 0.147,
  "result": [
    {
      "value": "t=20210208T140300&s=234.47&fn=9280440300828346&i=79684&fp=2901191157&n=1",
      "valuebase64": "dD0yMDIxMDIwOFQxNDAzMDAmcz0yMzQuNDcmZm49OTI4MDQ0MDMwMDgyODM0NiZpPTc5Njg0JmZwPTI5MDExOTExNTcmbj0x",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

{
  "time": 0.109,
  "result": [
    {
      "value": "t=20211016T110500&s=16120.00&fn=9961440300290883&i=1335&fp=214042868&n=1",
      "valuebase64": "dD0yMDIxMTAxNlQxMTA1MDAmcz0xNjEyMC4wMCZmbj05OTYxNDQwMzAwMjkwODgzJmk9MTMzNSZmcD0yMTQwNDI4Njgmbj0x",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

{
  "time": 0.637,
  "result": [
    {
      "value": "t=20211012T184700&s=104.50&fn=9960440300120912&i=35873&fp=4271345501&n=1",
      "valuebase64": "dD0yMDIxMTAxMlQxODQ3MDAmcz0xMDQuNTAmZm49OTk2MDQ0MDMwMDEyMDkxMiZpPTM1ODczJmZwPTQyNzEzNDU1MDEmbj0x",
      "type": "QR-CODE"
    }
  ],
  "code": 200
}

Errors

All errors return HTTP code 200 and JSON string with a property “error” with details.

No.	Error message	Details
1	Failed receiving image via link	An image could not be fetched with a provided link
2	Failed receiving image via Base64	Base64 decoding of a string to image failed
3	Failed receiving image directly	Image file upload failed
4	The file type is not supported	A file was uploaded, but the parser did not recognize it as an image
5	Code type not supported	A wrong type was provided. Please, check the ‘type’ field in your request
6	Internal error	Internal parser error.