Business registration certificate
    • PDF

    Business registration certificate

    • PDF

    Article summary

    Available in Classic and VPC

    Recognize and extract key-value input information from business registration certificates using a specialized model engine.

    Request

    This section describes the request format. The method and URI are as follows:

    MethodURI
    POST/biz-license

    Request headers

    For information about the headers common to all CLOVA OCR APIs, see CLOVA OCR request headers.

    Request body

    You can include the following data in the body of your request:

    If Content-Type: application/json

    You can include the following data in the body of your request if the request header's Content-Type is application/json:

    FieldTypeRequiredDescription
    versionString-Version information
    • Only use V2
    requestIdStringRequiredRandom API call UUID
    timestampIntegerRequiredRandom API call time (timestamp)
    imagesArrayRequiredimages details

    If Content-Type: multipart/form-data

    You can include the following data in the body of your request if the request header's Content-Type is multipart/form-data:

    FieldTypeRequiredDescription
    messageObjectRequiredRequest data information
    message.versionStringRequiredVersion information
    • Only use V2
    message.requestIdStringRequiredRandom API call UUID
    message.timestampIntegerRequiredRandom API call time (timestamp)
    message.imagesArrayRequiredimages details
    fileFileRequiredOCR recognition image file

    images

    The following describes images.

    FieldTypeRequiredDescription
    formatStringRequiredImage format
    • jpg | jpeg | png | pdf | tif | tiff
      • Image: jpg, jpeg, png
      • Single page: pdf, tif, tiff
    • Select and enter one of the image formats
    nameStringRequiredRandom image name
    • Use to identify images and check response results
    dataStringRequiredBase64-encoded image data
    • Can be entered if Content-Type: application/json

    Request example

    The request example is as follows:

    If Content-Type: application/json

    The request example if the request header's Content-Type is application/json is as follows:

    curl --location 'https://cbgrx5natw.apigw.ntruss.com/custom/v1/{DomainId}/{InvokeKey}/document/biz-license' \
    --header 'Content-Type: application/json' \
    --header 'X-OCR-SECRET: {Secret key issued when registering the app}' \
    --data '{
        "version": "V2",
        "requestId": "string",
        "timestamp": 0,
        "images": [
            { 
                "format": "jpg", 
                "name": "bizlicense_test", 
                "data": "{Base64-encoded image data}"
            }
        ]
     }'
    

    If Content-Type: multipart/form-data

    The request example if the request header's Content-Type is multipart/form-data is as follows:

    curl --location --request POST 'https://cbgrx5natw.apigw.ntruss.com/custom/v1/{DomainId}/{InvokeKey}/document/biz-license' \
    --header 'X-OCR-SECRET: {Secret key issued when registering the app}' \
    --header 'Content-Type: multipart/form-data' \
    --form 'message="{\"version\": \"V2\", \"requestId\": \"1234\", \"timestamp\": 1724832750462, \"images\": [{\"format\": \"pdf\", \"name\": \"bizlicense_test\"}]}"' \
    --form 'file=@"{file}"'
    

    Response

    This section describes the response format.

    Response body

    The response body includes the following data:

    FieldTypeRequiredDescription
    versionString-Version information
    • Only use V2
    requestIdString-Random API call UUID
    timestampInteger-API call time (timestamp)
    imagesArray-images details

    images

    The following describes images.

    FieldTypeRequiredDescription
    uidString-Business registration certificate image UID
    • Use for API validity checks
    nameString-Business registration certificate image name
    • Use to identify images and check response results
    inferResultString-Business registration certificate image recognition result
    • SUCCESS | FAILURE | ERROR
      • SUCCESS: recognition successful
      • FAILURE: recognition failure
      • ERROR: recognition processing exception
    messageString-Result message
    validationResultObject-Validity check result information
    validationResult.resultString-Validity check result code
    • NO_REQUESTED | UNCHECKED | ERROR | VALID | INVALID
      • NO_REQUESTED: no validation action requested (validity check failed)
      • UNCHECKED: unable to verify validation
      • ERROR: error on validation (validity check failed)
      • VALID: validation result valid (validity check succeeded)
      • INVALID: failed to pass validation
    validationResult.messageString-Validity check result details message
    • This value is not always returned
    convertedImageInfoObject-Converted image information
    • If format is pdf or tiff
    • Coordinate values are set relative to the called image file
    convertedImageInfo.widthInteger-Converted image width
    convertedImageInfo.heightInteger-Converted image height
    convertedImageInfo.pageIndexInteger-Converted image page index
    bizLicenseObject-Business registration certificate details
    bizLicense.metaObject-Meta information
    bizLicense.meta.estimatedLanguageString-OCR estimated language
    • ko | en | ja
      • ko:Korean
      • en: English
      • ja: Japanese
    bizLicense.resultObject-Business registration certificate OCR recognition result

    result

    The following describes result.

    FieldTypeRequiredDescription
    bisAddressArray-Business place address information
    bisAreaArray-Business place location information
    bisItemArray-Business item information
    registerNumberArray-Business registration number information
    bisTypeArray-Business category Information
    companyNameArray-Company name
    corpNameArray-Corporate (company) name
    corpRegisterNumArray-Corporate (company) business registration number
    coRepSocialNumArray-Co-representative's resident registration number
    documentTypeArray-Document type object information
    headAddressArray-Headquarters address information
    issuanceDateArray-Issuance date information
    issuanceReasonArray-Issuance reason information
    openDateArray-Business start date information
    repNameArray-Representative name information
    socialNumberArray-Resident registration number information
    taxTypeArray-Taxation type information

    Common object information

    The following describes the common object information.

    FieldTypeRequiredDescription
    textString-Recognized text
    keyTextString-Key value of recognized text
    confidenceScoreFloat-Confidence of recognized text
    • 0 - 1
    • The higher the confidence value, the more accurate the text is
    boundingPolysArray-boundingPoly details

    Document type object information

    The following describes the document type object information.

    FieldTypeRequiredDescription
    textString-Recognized text
    formattedObject-Recognized text information
    formatted.valueString-Recognized text value
    keyTextString-Key value of recognized text
    confidenceScoreFloat-Confidence of recognized text
    • 0 - 1
    • The higher the confidence value, the more accurate the text is
    boundingPolysArray-boundingPoly details
    maskingPolysArray-maskingPoly details

    boundingPolys

    The following describes boundingPolys.

    FieldTypeRequiredDescription
    verticesArray-vertices details

    maskingPolys

    The following describes maskingPolys.

    FieldTypeRequiredDescription
    verticesArray-vertices details

    boundingPolyvertices

    The following describes boundingPolyVertices.

    FieldTypeRequiredDescription
    xFloat-X-axis coordinate value
    yFloat-Y-axis coordinate value

    Response status codes

    For information about the HTTP status codes common to all CLOVA OCR APIs, see Common CLOVA OCR response status codes.

    Response example

    The response example is as follows:

    Success

    The following is a sample response upon a successful call.

    {
        "version": "V2",
        "requestId": "1234",
        "timestamp": 1725247772348,
        "images": [
            {
                "uid": "{uid}",
                "name": "bizlicense_test",
                "inferResult": "SUCCESS",
                "message": "SUCCESS",
                "validationResult": {
                    "result": "NO_REQUESTED"
                },
                "bizLicense": {
                    "meta": {
                        "estimatedLanguage": "ko"
                    },
                    "result": {
                        "bisAddress": [
                            {
                                "text": "Seoul***",
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 371.0,
                                                "y": 547.0
                                            },
                                            {
                                                "x": 479.0,
                                                "y": 550.0
                                            },
                                            {
                                                "x": 479.0,
                                                "y": 569.0
                                            },
                                            {
                                                "x": 371.0,
                                                "y": 567.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "bisItem": [
                            {
                                "text": "***",
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 760.0,
                                                "y": 695.0
                                            },
                                            {
                                                "x": 783.0,
                                                "y": 695.0
                                            },
                                            {
                                                "x": 783.0,
                                                "y": 716.0
                                            },
                                            {
                                                "x": 760.0,
                                                "y": 716.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "registerNumber": [
                            {
                                "text": "***-**-*****",
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 585.0,
                                                "y": 338.0
                                            },
                                            {
                                                "x": 636.0,
                                                "y": 338.0
                                            },
                                            {
                                                "x": 636.0,
                                                "y": 370.0
                                            },
                                            {
                                                "x": 585.0,
                                                "y": 370.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "bisType": [
                            {
                                "text": "Manufacturing wholesale",
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 434.0,
                                                "y": 695.0
                                            },
                                            {
                                                "x": 460.0,
                                                "y": 695.0
                                            },
                                            {
                                                "x": 460.0,
                                                "y": 716.0
                                            },
                                            {
                                                "x": 434.0,
                                                "y": 716.0
                                            }
                                        ]
                                    },
                                ]
                            }
                        ],
                        "corpName": [
                            {
                                "text": "Corporation***",
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 367.0,
                                                "y": 392.0
                                            },
                                            {
                                                "x": 391.0,
                                                "y": 392.0
                                            },
                                            {
                                                "x": 391.0,
                                                "y": 418.0
                                            },
                                            {
                                                "x": 367.0,
                                                "y": 418.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "corpRegisterNum": [
                            {
                                "text": "******-*********",
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 858.0,
                                                "y": 512.0
                                            },
                                            {
                                                "x": 902.0,
                                                "y": 512.0
                                            },
                                            {
                                                "x": 902.0,
                                                "y": 530.0
                                            },
                                            {
                                                "x": 858.0,
                                                "y": 530.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "documentType": [
                            {
                                "text": "Business registration certificate",
                                "formatted": {
                                    "value": "Business registration certificate"
                                },
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 376.0,
                                                "y": 220.0
                                            },
                                            {
                                                "x": 449.0,
                                                "y": 220.0
                                            },
                                            {
                                                "x": 449.0,
                                                "y": 287.0
                                            },
                                            {
                                                "x": 376.0,
                                                "y": 287.0
                                            }
                                        ]
                                    }
                                ],
                                "maskingPolys": []
                            }
                        ],
                        "headAddress": [
                            {
                                "text": "Seoul***",
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 368.0,
                                                "y": 622.0
                                            },
                                            {
                                                "x": 480.0,
                                                "y": 622.0
                                            },
                                            {
                                                "x": 480.0,
                                                "y": 643.0
                                            },
                                            {
                                                "x": 368.0,
                                                "y": 643.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "issuanceDate": [
                            {
                                "text": "January 7, 2021",
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 454.0,
                                                "y": 1299.0
                                            },
                                            {
                                                "x": 520.0,
                                                "y": 1299.0
                                            },
                                            {
                                                "x": 520.0,
                                                "y": 1325.0
                                            },
                                            {
                                                "x": 454.0,
                                                "y": 1325.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "openDate": [
                            {
                                "text": "August 16, 2001",
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 367.0,
                                                "y": 512.0
                                            },
                                            {
                                                "x": 418.0,
                                                "y": 512.0
                                            },
                                            {
                                                "x": 418.0,
                                                "y": 530.0
                                            },
                                            {
                                                "x": 367.0,
                                                "y": 530.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "repName": [
                            {
                                "text": "Lee**",
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 368.0,
                                                "y": 432.0
                                            },
                                            {
                                                "x": 393.0,
                                                "y": 432.0
                                            },
                                            {
                                                "x": 393.0,
                                                "y": 457.0
                                            },
                                            {
                                                "x": 368.0,
                                                "y": 457.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ],
                        "taxType": [
                            {
                                "text": "Corporate business",
                                "keyText": "",
                                "confidenceScore": 0.0,
                                "boundingPolys": [
                                    {
                                        "vertices": [
                                            {
                                                "x": 532.0,
                                                "y": 282.0
                                            },
                                            {
                                                "x": 564.0,
                                                "y": 282.0
                                            },
                                            {
                                                "x": 564.0,
                                                "y": 328.0
                                            },
                                            {
                                                "x": 532.0,
                                                "y": 328.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                }
            }
        ]
    }
    

    Failure

    The following is a sample response upon a failed call.

    {
        "code": "0011",
        "message": "Request invalid: Request data() is invalid.",
        "path": "{path}",
        "traceId": "{traceId}",
        "timestamp": 1725349186545
    }
    

    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.