Skip to main content
POST
/
v2
/
ocr
/
gst-certificate
Extract data from GST certificate
curl --request POST \
  --url https://bgv.konnectnxt.com/api/v2/ocr/gst-certificate/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_url": "https://example.com/documents/gst-certificate.pdf"
}
'
{
  "status": "success",
  "code": 200,
  "message": "Operation completed successfully",
  "data": {
    "gstin": "27AABCU9603R1ZX",
    "legal_name": "SAMPLE ENTERPRISES PRIVATE LIMITED",
    "trade_name": "SAMPLE ENTERPRISES",
    "pan_number": "AABCU9603R",
    "address": "123, Sample Street, Industrial Area, Mumbai, Maharashtra, 400001",
    "constitution_of_business": "Private Limited Company",
    "type_of_registration": "Regular",
    "date_of_liability": null,
    "valid_from": "2020-01-15",
    "valid_upto": "NA",
    "is_provisional": false
  },
  "credits_used": 10,
  "credits_remaining": 5000
}
Document Requirements:
  • Clear, high-resolution document
  • Valid GST certificate
  • Supported formats: PDF, JPG, JPEG, PNG
  • Maximum file size: 10 MB

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
document_url
string<uri>
required

Publicly accessible URL of the GST certificate document to be processed.

Requirements:

  • Must be a valid HTTP/HTTPS URL
  • Document must be publicly accessible
  • Supported formats: PDF, JPG, JPEG, PNG
Example:

"https://example.com/documents/gst-certificate.pdf"

Response

GST certificate data extracted successfully

​
status
enum<string>
required

Overall status of the API

Available options:
success,
error
​
code
integer
required

HTTP status code

Example:

400

​
message
string
required

Description of the response or error

Example:

"Invalid request parameters"

​
data
object
required

Extracted GST certificate information

​
credits_used
integer
required

Represents the total number of credits used in this request.

Example:

3

​
credits_left
integer
required

Represents the remaining credits available for use.

Example:

4040