Invoice OCR Extract

API Details

Method: POST

Endpoint: /api/api/api-module/invoice-ocr/extract

Base URL: https://uatapi.wowpe.in

Authentication

Header	Type	Description
`X-Client-Id`	String	Assigned client ID.
`X-Client-Secret`	String	Assigned client secret.

Request Parameters

Content-Type: multipart/form-data

Parameter	Type	Mandatory	Description
`files`	File	Yes	Invoice document(s) to extract. Use the same field name for multiple uploads.

Sample Request

curl -X POST \
  'https://uatapi.wowpe.in/api/api/api-module/invoice-ocr/extract' \
  -H 'X-Client-Id: YOUR_CLIENT_ID' \
  -H 'X-Client-Secret: YOUR_CLIENT_SECRET' \
  -F '[email protected]'

Sample Success Response

{
  "statusCode": 1,
  "message": "Success",
  "rows": [
    {
      "beneficiaryName": "",
      "uniqueRefNo": "0008",
      "amount": 1180.0,
      "grossAmount": 1180.0,
      "taxableValue": 1000.0,
      "cgst": 0.0,
      "sgst": 0.0,
      "igst": 180.0,
      "gstAmount": 180.0,
      "confidence": 20,
      "sourceFile": "invoice.pdf",
      "sourcePages": "Pages 1",
      "extractionMethod": "Embedded PDF text",
      "reviewRequired": true
    }
  ],
  "reviewRequired": true
}

Sample Rejection Response

{
  "statusCode": 0,
  "message": "Use PDF, XML or JSON invoice files.",
  "rows": [],
  "reviewRequired": true
}

Response Parameters

Parameter	Type	Description
`statusCode`	Number	Business-level status. `1` indicates success and `0` indicates rejection in the observed UAT cases.
`message`	String	Response message.
`rows`	Array	Contains extracted invoice records.
`beneficiaryName`	String	Extracted beneficiary name.
`uniqueRefNo`	String	Invoice reference number.
`amount`	Number	Reported invoice amount.
`grossAmount`	Number	Reported gross amount.
`taxableValue`	Number	Reported taxable amount.
`cgst`	Number	Central GST amount.
`sgst`	Number	State GST amount.
`igst`	Number	Integrated GST amount.
`gstAmount`	Number	Reported GST amount.
`confidence`	Number	Extraction confidence value. Its scale has not been verified.
`sourceFile`	String	Source document name.
`sourcePages`	String	Source page information.
`extractionMethod`	String	Extraction method reported by the API.
`reviewRequired`	Boolean	Indicates that human review is required.

Error Handling

HTTP 200 with statusCode: 0

The request may return HTTP 200 even when the extraction is rejected. Check the business-level statusCode and message before treating the request as successful.

Important Notes

PDF extraction was observed in UAT.
PNG and JPEG uploads were rejected in the tested cases.
XML and JSON extraction remain unverified despite being mentioned in the rejection message.
Blank or supporting pages may produce additional invoice-shaped rows.
The confidence value should not be interpreted as a calibrated probability.
Verify extracted amounts, invoice identity and tax details before further processing.

What's Next

Review the extracted invoice records and correct any inaccuracies before submitting approved data for reconciliation.