---
title: "Barcode Scanner"
url: https://docs.catalyst.zoho.com/en/api/code-reference/zia-services/barcode-scanner/
description: "This API enables you to decode the data encoded in a barcode from an image file."
last_updated: 2026-08-17T12:16:04Z
service: Zia Services
type: api
---

# Barcode Scanner

[Zia Barcode Scanner](https://docs.catalyst.zoho.com/en/zia-services/help/barcode-scanner/introduction/) enables you to scan the most commonly used linear and 2D barcode formats and decode the encoded data. Barcode Scanner can detect formats like Codabar, EAN-13, ITF, UPC-A, QR Code, and more.

# Execute Barcode Scanner

### Description

This API is used to decode the data encoded in a barcode from an image file. You must specify the path to the image file in the API request, as shown in the sample request.

You can optionally specify the barcode format. If you don't specify it, Catalyst will automatically process the default value `all` for it. The JSON response returns the decoded data.

### Request Details

#### Request URL

`POST` {api-domain}/baas/v1/project/{project_id}/ml/barcode

- **api-domain** (URL): The DC-specific domain to access Catalyst API

- **project_id** (Numerical): The [unique ID](https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/general-settings/) of the project

#### Request Headers
 **Authorization:** Zoho-oauthtoken {oauth_token} 

**content-type:** multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

**Optional Headers** 

 **CATALYST-ORG:** {org_id}

 **Environment:** Development

#### Scope

ZohoCatalyst.mlkit.READ

#### Request JSON Properties

- **file** (file, mandatory):  The input file with the barcode to be scanned. 

Allowed formats: *.webp, .jpeg, .png*, .txt 

File size limit: 10 MB  

Resolution limit: 36000000 pixels

- **format** (string, optional):  The format of the barcode in the image. The format codes are specified in the table below.

You must provide the path to it in your local system.

Allowed formats: .webp, .jpeg, .png 

File size limit: 10 MB   

#### Barcode Format Codes

<table class="content-table">
	<thead>
		<tr>
			<th class="w50p">Barcode Format</th>
			<th class="w50p">Format Code</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td>Code 39</td>
			<td>`code39`</td>
		</tr>
		<tr>
			<td>Code 128</td>
			<td>`code128`</td>
		</tr>
		<tr>
			<td>Code 93</td>
			<td>`code93`</td>
		</tr>
		<tr>
			<td>Ean 8</td>
			<td>`ean8`</td>
		</tr>
		<tr>
			<td>Ean 13</td>
			<td>`ean13`</td>
		</tr>
		<tr>
			<td>Codabar</td>
			<td>`codabar`</td>
		</tr>
		<tr>
			<td>ITF</td>
			<td>`itf`</td>
		</tr>
		<tr>
			<td>UPC-A</td>
			<td>`upca`</td>
		</tr>
		<tr>
			<td>UPC-E</td>
			<td>`upce`</td>
		</tr>
		<tr>
			<td>RSS</td>
			<td>`rss`</td>
		</tr>
		<tr>
			<td>QR code</td>
			<td>`qrcode`</td>
		</tr>
		<tr>
			<td>Aztec</td>
			<td>`aztec`</td>
		</tr>
		<tr>
			<td>PDF417</td>
			<td>`pdf417`</td>
		</tr>
		<tr>
			<td>Data Matrix</td>
			<td>`datamatrix`</td>
		</tr>
		<tr>
			<td>If you don't know the format

			or if you don't specify it</td>
			<td>`all`</td>
		</tr>
	</tbody>
</table>

### Response Details

The response will contain the data detected in the barcode in the `content` field.

**Sample Request**

```bash
curl -X POST \
  https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr \
  -H "Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57" \
  -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" \
  -F "file=@attachment1.txt"  \
-d '{
        "format": "ITF"
      }'

```

**Sample Response**

```json

	{
		"status": "success",
		"data": {
			"content": "40156"
		}
	}
```

### SDK Documentation

[Barcode Scanner- Java SDK](https://docs.catalyst.zoho.com/en/sdk/java/v1/zia-services/barcode-scanner)</br></br>
[Barcode Scanner- Node.js SDK](https://docs.catalyst.zoho.com/en/sdk/nodejs/v2/zia-services/barcode-scanner)</br></br>
[Barcode Scanner- Python SDK](https://docs.catalyst.zoho.com/en/sdk/python/v1/zia-services/barcode-scanner)</br></br>