Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Contact Us
  • Home
  • API, CLI, and SDK Documentation
  • REST API Documentation
  • Administration Tools and Settings Using REST API

Configuring OCR Through the REST API

Learn how to configure the OCR setting using the DryvIQ REST API.

Written by Andrea Harvey

Updated at June 23rd, 2025

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Insights
    Prebuilt Insights Custom Insights
  • Content
  • Accounts
  • Activity Log
  • Content Scans
  • Migrations
    Migration Jobs Migration Reports Maps Flagged Items Migration Tools
  • Connections
    Supported Platform Connections Creating Connections Connection Maintenance Connection Pools
  • Entity Types
    DryvIQ Available Entity Types Custom Entity Types Entity Type Maintenance
  • Action Sets
    Creating Action Sets Action Sets Maintenance
  • Settings
    License Performance Notifications Extensions Entity Types Settings Display Settings Configuration
  • API, CLI, and SDK Documentation
    REST API Documentation Command-line Interface SDK Development
  • POC Offering
  • Release Notes
+ More

Table of Contents

Overview Viewing the Current OCR Setting Example Response Configuring the OCR Setting Setting in the Request Body Setting in the Request

Overview

Optical character recognition (OCR) allows DryvIQ to extract text from images, including images in PDF files and other document types. This global setting turns OCR on and off for your DryvIQ Platform. To evaluate files against entity types and policies, you must enable OCR. For content scans, OCR will be enabled or disabled for new scans automatically in the Settings step of the content scan setup based on this setting, but you can override the default for individual scans as desired. Enabling OCR is only valid when using templates that scan a file’s contents (File Categories, Sensitive Data Detection, and Miscellaneous templates) and may increase the scan time. 

Viewing the Current OCR Setting

Use the following request to view the current OCR setting.

GET {{url}}v1/entity_types/test/ocr_config

Example Response

The response identifies the “mode” as off or on. The following example shows a response for an OCR setting that is on.

{
   "status": 200,
   "item": {
       "mode": "off"
   }
}

Configuring the OCR Setting

You can set the OCR value in the body of a PATCH request or in the request itself. The following examples show how to turn on the OCR setting.

Setting in the Request Body

PATCH {{url}}v1/entity_types/test/ocr_config

Body

{
  "mode": "on" 
}

Setting in the Request

PATCH {{url}}v1/entity_types/test/ocr_config?mode=on

 

api integration setting ocr ocr

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Enabling Optical Character Recognition (OCR)
  • Sample Context Capture

Copyright 2025 – DryvIQ, Inc.

Knowledge Base Software powered by Helpjuice

Expand