MENU
      CLOVA OCR overview
        • PDF

        CLOVA OCR overview

        • PDF

        Article summary

        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
        HTTP
        Note

        To check the invoke URL, see the CLOVA OCR User Guide.

        Request headers

        The following describes the headers.

        FieldRequiredDescription
        X-OCR-SECRETRequiredClient secret created in NAVER Cloud Platform domain when integrating with API Gateway
        Content-TypeRequiredRequest data format
        • application/json | multipart/form-data

        Response

        The following describes the common response format.

        Response status codes

        The following describes the response status codes.

        HTTP status codeCodeMessageDescription
        4000001URL is invalid.Invalid call URL entered
        • Check that the POST URL you called is correct
        4010002Secret key validate failed.Entered secret key not validated
        • Check if the X-OCR-SECRET:{Client Secret} value is accurate
        4000011Request body invalid.Entered request body value is invalid
        4000021Protocol version not support.Unsupported API version
        4000022Request domain invalid.Entered request domain value is invalid
        4000023API request count reach the upper limit.API call limit reached
        4000025Calls to this api have exceeded the rate limit.API call count exceeds rate limit
        4000028Table detection disabled: Please activate the table extractor button.If the table extraction is OFF, call with enableTableDetection: true
        5000500Unknown service error.Unknown service error occurred
        5000501OCR service error.OCR service error occurred
        5001021Not found deploy information. Please confirm the template is released.Template deployment history not found
        • Need to check whether the template is deployed to the domain in NAVER Cloud Platform console
        Note

        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.

        APIDescription
        General OCRPlain text and table extraction OCR
        Template OCRTemplate OCR
        Document OCR > Business cardBusiness card information OCR
        Document OCR > Business registration certificateBusiness registration certificate information OCR
        Document OCR > Credit cardCredit card information OCR
        Document OCR > ReceiptReceipt information OCR
        Document OCR > ID card > PassportPassport information OCR
        Document OCR > ID card > Alien registration cardAlien registration card information OCR
        Document OCR > ID card > Driver's licenseDriver's license information OCR
        Document OCR > ID card > Resident registration cardResident registration card information OCR

        NAVER Cloud Platform provides a variety of related resources to help users better understand CLOVA OCR APIs.


        Was this article helpful?

        What's Next
        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.