Available in Classic and VPC
CLOVA OCR (Optical Character Recognition) is a NAVER Cloud Platform service that recognizes transmitted documents or images and accurately extracts text and data in user-specified areas. It provides APIs in RESTful form for recognizing all text in images, recognizing text in images with templates deployed in a domain, and quickly extracting only the required text within a template.
Common CLOVA OCR settings
The following describes commonly used request and response formats in CLOVA OCR APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
API Gateway's unique invoke URL created in CLOVA OCR Builder
To check the invoke URL, see the CLOVA OCR User Guide.
Request headers
The following describes the headers.
| Field | Required | Description |
|---|---|---|
X-OCR-SECRET |
Required | Client secret created in NAVER Cloud Platform domain when integrating with API Gateway |
Content-Type |
Required | Request data format
|
Response
The following describes the common response format.
Response status codes
The following describes the response status codes.
| HTTP status code | Code | Message | Description |
|---|---|---|---|
| 400 | 0001 | URL is invalid. | Invalid call URL entered.
|
| 401 | 0002 | Secret key validate failed. | Entered secret key not validated.
|
| 400 | 0011 | Request body invalid. | Entered request body value is invalid. |
| 400 | 0021 | Protocol version not support. | Unsupported API version. |
| 400 | 0022 | Request domain invalid. | Entered request domain value is invalid. |
| 400 | 0023 | API request count reach the upper limit. | API call limit reached. |
| 400 | 0025 | Calls to this api have exceeded the rate limit. | API call count exceeds rate limit. |
| 400 | 0028 | Table detection disabled: Please activate the table extractor button. | Called with enableTableDetection: true under the table extration status of OFF. |
| 500 | 0500 | Unknown service error. | Unknown service error occurred. |
| 500 | 0501 | OCR service error. | OCR service error occurred. |
| 500 | 1021 | Not found deploy information. Please confirm the template is released. | Template deployment history not found.
|
| 500 | 1022 | Service is blocked. | Service temporarily unavailable. |
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
CLOVA OCR API
The following describes the APIs provided by the CLOVA OCR service.
| API | Description |
|---|---|
| General OCR | Plain text and table extraction OCR |
| Template OCR | Template OCR |
| Document OCR > Business card | Business card information OCR |
| Document OCR > Business registration certificate | Business registration certificate information OCR |
| Document OCR > Credit card | Credit card information OCR |
| Document OCR > Receipt | Receipt information OCR |
| Document OCR > ID card > Passport | Passport information OCR |
| Document OCR > ID card > Alien registration card | Alien registration card information OCR |
| Document OCR > ID card > Driver's license | Driver's license information OCR |
| Document OCR > ID card > Resident registration card | Resident registration card information OCR |
CLOVA OCR related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand CLOVA OCR APIs.
- CLOVA OCR API guides
- Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by the CLOVA OCR service
- API Gateway User Guide: how to use API Gateway required for calling CLOVA OCR APIs
- Object Storage User Guide: how to use Object Storage required for the use of CLOVA OCR
- Sub Account User Guide: how to use Sub Account that helps the management of CLOVA OCR's administration permissions
- Call Text OCR API: introduction to calling Text OCR API
- How to use the CLOVA OCR service
- CLOVA OCR User Guide: how to use the CLOVA OCR service, create and manage batches (batch processing of large volumes of images), check usage, and set up notifications in NAVER Cloud Platform console
- Prerequisites for using CLOVA OCR: supported specifications, limitations, and usage fees in order to use CLOVA OCR
- OCR Reader: how to use the OCR Reader
- Ncloud use environment guide: guide on VPC and Classic environments and supported features
- Introduction to pricing, characteristics, and detailed features: summary of CLOVA OCR pricing system, characteristics, and detailed features of CLOVA OCR
- Latest service news: the latest news on CLOVA OCR
- FAQ: frequently asked questions from CLOVA OCR users
- Contact us: Send direct inquiries in case of any unresolved questions that aren't answered by the user guides.