---
title: "Get OCR request"
method: GET
path: "/ocr/{request_id}"
tags: ["OCR"]
---

# Get OCR request

`GET /ocr/{request_id}`

## Request

- Base URL: `https://us.app.zuva.ai/api/v2`
- URL: `https://us.app.zuva.ai/api/v2/ocr/{request_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/zuva/apis/zuva-docai/docs/ocr/:request_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the status of an OCR request.

## Path parameters

- `request_id` string, required

## Response `200`

The status of an OCR request

- OcrRequestStatus
  - `error` HttpErrorDetails
    - `code` string, required: A unique string identifying the error.
    - `message` string, required: An error message providing more details and potential steps to resolve.
  - `file_id` string, required
  - `request_id` string, required
  - `status` 'queued' | 'processing' | 'complete' | 'failed', required
  - `page_count` integer
  - `character_count` integer
  - `scan_quality` string
  - `scan_score` integer

## Other responses

- `400`: Invalid request ID
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Request not found.
- `500`: Internal Server Error

## Changes

- **2023-12-13** `51f2a4c5de2e`: 4 info
  - added the optional property `character_count` to the response with the `200` status
  - added the optional property `page_count` to the response with the `200` status
  - added the optional property `scan_quality` to the response with the `200` status
  - added the optional property `scan_score` to the response with the `200` status

[Operation history](https://skmtc.dev/zuva/apis/zuva-docai/changes/ocr/:request_id/get.md)

---

[API](https://skmtc.dev/zuva/apis/zuva-docai.md) - [All operations](https://skmtc.dev/zuva/apis/zuva-docai/llms.txt) - [OpenAPI document](https://skmtc.dev/zuva/apis/zuva-docai/revisions/7397ad071d55?raw)