> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# OCR Web Service

> OCR Web Service provides SOAP and REST APIs for integrating Optical Character Recognition (OCR) technology into software products, mobile devices, or other web services.

![OCR Web Service logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/ocr_web_service.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=187cd2e6ac2cf681ec4602e2979ec539)

* **Category:** ai document extraction
* **Auth:** BASIC
* **Composio-managed OAuth available?** N/A
* **Tools:** 4
* **Triggers:** 0
* **Slug:** `OCR_WEB_SERVICE`
* **Version:** 20261101\_00

## Tools

> [accordion] Get Account Credentials
>
> **Slug:** `OCR_WEB_SERVICE_GET_ACCOUNT_CREDENTIALS`
>
> Extract OCRWebService username and license code from a quoted Basic Auth --user credential in the connection metadata.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Information
>
> **Slug:** `OCR_WEB_SERVICE_GET_ACCOUNT_INFORMATION`
>
> Retrieve OCRWebService account information including remaining pages, subscription plan, and expiration date. Use this tool to check your account status before large OCR jobs — exhausted page quotas will cause OCR\_WEB\_SERVICE\_RECOGNIZE to fail mid-run. Returns details about your subscription including pages remaining and plan expiration. If credentials are invalid or stale, retrieve fresh user\_name and license\_code via OCR\_WEB\_SERVICE\_GET\_ACCOUNT\_CREDENTIALS before retrying. Requires valid OCRWebService credentials (username and license code).
>
> #### Input Parameters
>
> **user\_name** `string` *required*
>
> OCRWebService account username for authentication
>
> **license\_code** `string` *required*
>
> OCRWebService account license code (API key) for authentication
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] OCR Web Service Log
>
> **Slug:** `OCR_WEB_SERVICE_LOG`
>
> Retrieve OCR processing logs for an account and date range as a single string.
>
> #### Input Parameters
>
> **to\_date** `string` *required*
>
> End date for log (YYYY-MM-DD)
>
> **reserved** `array`
>
> Reserved values, if any
>
> **from\_date** `string` *required*
>
> Start date for log (YYYY-MM-DD)
>
> **user\_name** `string` *required*
>
> Account user name
>
> **license\_code** `string` *required*
>
> Account license code
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] OCRWebService Recognize
>
> **Slug:** `OCR_WEB_SERVICE_RECOGNIZE`
>
> Tool to call SOAP Recognize operation. Use when performing OCR on an image to retrieve text, output document, word coordinates, and errors. Consumes page quota per call; returns HTTP 429 when limits exceeded. Check quota via OCR\_WEB\_SERVICE\_GET\_ACCOUNT\_INFORMATION before large jobs; batch large PDFs in \~25–50 page chunks.
>
> #### Input Parameters
>
> **user\_name** `string` *required*
>
> OCRWebService account username
>
> **OCRWSSetting** `object` *required*
>
> OCR processing settings (languages, output, options)
>
> **license\_code** `string` *required*
>
> OCRWebService account license code
>
> **OCRWSInputImage** `object` *required*
>
> Input file container (name + data)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
