Warehouse Receipt OCR

API Description

Objective

The Warehouse Receipt OCR API extracts data from warehouse receipt documents using Optical Character Recognition (OCR) technology and returns the information in JSON format.

Input	Output
The warehouse receipt image	Structured data including receipt number, warehouse details, commodity information, insurance details, and financial values. The complete list of output fields is available in the Success Response Details section

Warehouse Receipt

A Warehouse Receipt is a document that serves as proof of ownership for commodities stored in a warehouse. This receipt contains detailed information about the stored goods, warehouse details, insurance coverage, and financial terms.

API URL

https://ind-engine.thomas.hyperverge.co/v1/readWHReceipt

API Endpoint

readWHReceipt

Overview

The Warehouse Receipt OCR API is RESTful and uses standard HTTP verbs and status codes. The responses are in JSON format and you should send all data in JSON format through a POST request.

Authentication

You need a unique pair of application ID ( appId ) and application key (appKey) from HyperVerge to verify your identity for accessing the API.

API Request Details

Method - `POST`

Headers

Parameter	Mandatory or Optional	Description	Valid Values
content-type	Mandatory	This parameter defines the media type for the request payload.	application/json
appId	Mandatory	Application ID shared by HyperVerge	N/A. This is a unique value.
appKey	Mandatory	Application Key shared by HyperVerge	N/A. This is a unique value.
transactionId	Mandatory	Unique transaction identifier for tracking	N/A. This should be a unique value.

Input

The following table provides the details of the parameters required for the Warehouse Receipt OCR API's request body:

Parameter	Mandatory or Optional	Description	Allowed Values	Default Value
`image`	Mandatory	The warehouse receipt image to be processed for OCR extraction	The file format can be JPG, JPEG, PNG, or PDF	Not Applicable

Request

The following code snippet demonstrates a standard curl request for the Warehouse Receipt OCR API:

curl --location --request POST 'https://ind-engine.thomas.hyperverge.co/v1/readWHReceipt' \
--header 'Content-Type: application/json' \
--header 'appId: <Enter_the_HyperVerge_appId>' \
--header 'appKey: <Enter_the_HyperVerge_appKey>' \
--header 'transactionId: <Enter_the_Transaction_ID>' \
--data '{
    "image": @"<Warehouse_Receipt_Image>"'
}'

Document Sample

The following is a Warehouse Receipt:
warehouse_receipt_ocr_api|

Success Response

The following code snippet demonstrates a success response from the Warehouse Receipt OCR API:

{
    "status": "success",
    "statusCode": 200,
    "result": {
        "details": [
            {
                "fieldsExtracted": {
                    "receiptNumber": {
                        "value": "<Receipt_Number>"
                    },
                    "CARNumber": {
                        "value": "<CAR_Number>"
                    },
                    "SRNumber": {
                        "value": "<SR_Number>"
                    },
                    "dateOfIssue": {
                        "value": "<Date_Of_Issue>"
                    },
                    "dateOfDeposit": {
                        "value": "<Date_Of_Deposit>"
                    },
                    "warehouseName": {
                        "value": "<Warehouse_Name>"
                    },
                    "warehouseAddress": {
                        "value": "<Warehouse_Address>"
                    },
                    "warehouseDistrict": {
                        "value": "<Warehouse_District>"
                    },
                    "warehouseState": {
                        "value": "<Warehouse_State>"
                    },
                    "depositorName": {
                        "value": "<Depositor_Name>"
                    },
                    "commodityName": {
                        "value": "<Commodity_Name>"
                    },
                    "commodityVariety": {
                        "value": "<Commodity_Variety>"
                    },
                    "units": {
                        "value": "<Units>"
                    },
                    "marketRate": {
                        "value": "<Market_Rate>"
                    },
                    "netWeight": {
                        "value": "<Net_Weight>"
                    },
                    "commodityValue": {
                        "value": "<Commodity_Value>"
                    },
                    "receiptValidityStartDate": {
                        "value": "<Receipt_Validity_Start_Date>"
                    },
                    "receiptValidityEndDate": {
                        "value": "<Receipt_Validity_End_Date>"
                    },
                    "fireInsurancePolicyNumber": {
                        "value": "<Fire_Insurance_Policy_Number>"
                    },
                    "fireInsuranceValidityStartDate": {
                        "value": "<Fire_Insurance_Validity_Start_Date>"
                    },
                    "fireInsuranceValidityEndDate": {
                        "value": "<Fire_Insurance_Validity_End_Date>"
                    },
                    "burglaryInsurancePolicyNumber": {
                        "value": "<Burglary_Insurance_Policy_Number>"
                    },
                    "burglaryInsuranceValidityStartDate": {
                        "value": "<Burglary_Insurance_Validity_Start_Date>"
                    },
                    "burglaryInsuranceValidityEndDate": {
                        "value": "<Burglary_Insurance_Validity_End_Date>"
                    },
                    "lenderName": {
                        "value": "<Lender_Name>"
                    },
                    "digitallySignedBy": {
                        "value": "<Digitally_Signed_By>"
                    },
                    "digitalSignatureDate": {
                        "value": "<Digital_Signature_Date>"
                    }
                },
                "type": "Warehouse Receipt"
            }
        ]
    },
    "metadata": {
        "requestId": "<Request_ID>",
        "transactionId": "<Transaction_ID>"
    }
}

Success Response Details

The following table outlines the details of the success response from the Warehouse Receipt OCR API:

Parameter	Type	Description
status	string	The status of the request
statusCode	integer	The status code of the response
result	object	The result object containing the extracted warehouse receipt details
details	array	The array containing the extracted document details
fieldsExtracted	object	The object containing all extracted fields from the warehouse receipt
receiptNumber	object	The unique receipt number assigned to the warehouse receipt
CARNumber	object	The CAR (Central Agricultural Repository) number associated with the receipt
SRNumber	object	The SR (Storage Receipt) number for the warehouse receipt
dateOfIssue	object	The date when the warehouse receipt was issued
dateOfDeposit	object	The date when the commodity was deposited in the warehouse
warehouseName	object	The name of the warehouse where the commodity is stored
warehouseAddress	object	The complete address of the warehouse facility
warehouseDistrict	object	The district where the warehouse is located
warehouseState	object	The state where the warehouse is located
depositorName	object	The name of the individual or entity who deposited the commodity
commodityName	object	The name of the commodity stored in the warehouse
commodityVariety	object	The specific variety or type of the commodity
units	object	The number of units of the commodity stored
marketRate	object	The current market rate per unit of the commodity
netWeight	object	The net weight of the commodity in the specified units
commodityValue	object	The total value of the commodity based on quantity and market rate
receiptValidityStartDate	object	The start date from which the warehouse receipt is valid
receiptValidityEndDate	object	The end date until which the warehouse receipt remains valid
fireInsurancePolicyNumber	object	The policy number for fire insurance coverage of the commodity
fireInsuranceValidityStartDate	object	The start date of fire insurance coverage
fireInsuranceValidityEndDate	object	The end date of fire insurance coverage
burglaryInsurancePolicyNumber	object	The policy number for burglary insurance coverage of the commodity
burglaryInsuranceValidityStartDate	object	The start date of burglary insurance coverage
burglaryInsuranceValidityEndDate	object	The end date of burglary insurance coverage
lenderName	object	The name of the lending institution if the receipt is pledged as collateral
digitallySignedBy	object	The name of the person who digitally signed the warehouse receipt
digitalSignatureDate	object	The date when the warehouse receipt was digitally signed
type	string	The type of document that was processed
metadata	object	The metadata object containing request tracking information
requestId	string	The unique identifier for the request
transactionId	string	The transaction identifier for tracking

Error Responses

The following are some error responses from the API:

{
    "status": "failure",
    "statusCode": 400,
    "error": "API call requires one input image"
}

{
    "status": "failure",
    "statusCode": 400,
    "error": "Image size cannot be greater than 6MB"
}

{
    "status": "failure",
    "statusCode": 422,
    "error": "Document Not Detected"
}

{
    "message": "Missing/Invalid credentials",
    "statusCode": 401,
    "status": "failure"
}

{
    "message": "Internal Server Error",
    "statusCode": 500,
    "status": "failure"
}

{
    "message": "Service Unavailable",
    "statusCode": 503,
    "status": "failure"
}

Failure and Error Response Details

A failure or error response from the module contains a failure status, with a relevant status code and error message.
The following table lists all error responses:

Status Code	Error	Error Description
400	API call requires one input image	The request is missing the required image input parameter
400	Image size cannot be greater than 6MB	The request contains an image file that exceeds the maximum allowed size of 6MB
401	Missing/Invalid credentials	The request is either missing the mandatory `appId` and `appKey` combination or has invalid values
422	Document Not Detected	The request contains an image where no warehouse receipt document could be identified or detected
500	Internal Server Error	The request has an internal server error. Please check the request headers or contact the HyperVerge team for investigation
503	Service Unavailable	The Warehouse Receipt OCR service is currently unavailable. Please try again later or contact the HyperVerge team for investigation

Important Notes

If multiple images are sent to the server in the same call, only one of the images will be read. Hence it is advisable to only send one image per call.
For PDF documents, if the document has multiple pages, only the first three pages will be processed.
The API supports JPG, PNG, and PDF file formats for input images.
All extracted field values are returned as strings, even for numeric fields.
Empty fields will be returned with empty string values.

API Description​

Objective​

API URL​

API Endpoint​

Overview​

Authentication​

API Request Details

Method - POST

Headers

Input​

Request​

Success Response​

Success Response Details​

Error Responses​

Failure and Error Response Details​