Skip to main content

KYB Documents OCR

Module ID​

Name of the ModuleDocuments Supported
module_kyb_documents_ocrGST certificate, Shop and Establishment certificate, Udyam Certificate

Description​

The KYB Documents OCR extracts accurate information from any of the following KYB documents received as an image.

  • Shop and Establishment certificate
  • Udyam Certificate
  • GST certificate
  • Certificate of Incorporation
caution

This product might provide mixed results when used on other business documents. We recommend discussing it with the HyperVerge team before using it on other business documents.

Module Inputs​

The following table provides the details of the parameters required for the module.

Parameter Mandatory or Optional Description
image Mandatory This is the KYB file on which you intended to run the OCR extraction. The input file can either be an image file (with JPEG, PNG, or TIFF extension) or a Portable Document Format(PDF) file.
note

The KYB identity cards are expected to have the information only on one side of the card. Only the first page of the document is considered as the input. In case the KYB input document has multiple pages, you will have to make individual requests to the module for each page of the document.

Image Input Guidelines​

  • The API supports JPEG, PNG and TIFF images and PDFs inputs.
  • Ensure that the document in the image is legible. This is a rule of thumb for our OCR servers to accurately extract any text from an image.
  • Reduce the size of the image as much as possible to optimise the reponse time while also ensuring its legibility criteria as mentioned earlier. Larger image sizes lead to higher uploading and processing time.
  • You can keep the width of the ID card image at least 800 pixels and the JPEG compression quality factor above 80%.
  • For our DL server to extract text from the document, the aspect ratio of the input image should be the same as the aspect ratio of the original document. Hence utmost care should be taken while resizing the image to maintain the aspect ratio

Module Configurations​

This module does not support any additional configurations.

Module Outputs​

You will receive a success response in a format similar to the following sample code for a GST certificate input.

  {
"status": "success",
"statusCode": "200",
"result": [
  {
    "details": {
      "reg_no": {
        "value": "27** *********Z2",
        "conf": 0.93,
        "to-be-reviewed": "no"
      },
      "legal_name": {
        "value": "",
        "conf": 0,
        "to-be-reviewed": "yes"
      },
      "trade_name": {
        "value": "COLLECTION",
        "conf": 0.79,
        "to-be-reviewed": "no"
      },
      "business_constitution": {
        "value": "PROPRIETORSHIP",
        "conf": 0.99,
        "to-be-reviewed": "no"
      },
      "address": {
        "value": "UGAMSHI BHARMAL GALA ZALANI GROUND FLOOR, SHOP NO.2, SHIV DARSHAN SHOPPING CENTER, OPP . RAILWAY STATION , SANTA CRUZ(W), MUMBAI SUBURBAN, MAHARASHTRA , 400054",
        "conf": 0.94,
        "to-be-reviewed": "no"
      },
      "date_liability": {
        "value": "",
        "conf": 0,
        "to-be-reviewed": "yes"
      },
      "valid_from": {
        "value": "01/07/2017",
        "conf": 0.99,
        "to-be-reviewed": "no"
      },
      "valid_till": {
        "value": "",
        "conf": 0,
        "to-be-reviewed": "yes"
      },
      "type": {
        "value": "",
        "conf": 0,
        "to-be-reviewed": "yes"
      }
    },
    "type": "GST"
  }
],
"requestId": "<Request_ID>"
}

Success Response Details for GST Certificate

A success response from the module reflects the success status with a status code of 200 and a result object containing the response data with the following field-value pairs.


AttributesDescriptionValues Returned
typeThe type of KYB document detected>GST, ShopEstablishmentCertificate, MSME, or COI
reg_no - N/A - It depends on the actual value in the input document.
legal_name -
trade_name -
business_constitution -
address -
date_liability -
valid_from -
valid_till -
You will receive the error responses similar to the following code samples if the request is incorrect.
{
"status": "failure",
"statusCode": "400",
"error": "API call requires one input image",
}

Error Response Details

An error response from the module contains a failure status, with a relavant status code and error message. The following table lists all error responses.

Status CodeError MessageError Description
400No Image inputThe request missed the image input.
400More than 1 image inputThe request had more than one image file input. It expects only one file in the request.
400image size cannot be greater than 12MBThe image size is larger than the allowed limit.
422Document not detected from ImageThe module failed to detect a document in the image. Ensure that the image captures the document following the guidlines mentioned under the Input Image Guidelines section.
5xxInternal Server Error There was an error with HyperVerge's server. Please contact the HyperVerge team.
Last updated on
Was this helpful?
ON THIS PAGE
Ask AIBeta
Hi! How can I help?
Ask me anything about HyperVerge products, APIs, and SDKs.
Try asking: