GST Certificate Extraction

Introduction

The GST Certificate Extraction API is a powerful tool designed to simplify and expedite the extraction of data from GST certificates. As businesses increasingly digitize their processes, having access to accurate Goods and Services Tax (GST) certification data has become essential.

However, manually extracting relevant information from GST certificates can be both time-consuming and error-prone. To address this challenge, our GST Certificate Extraction API employs cutting-edge algorithms to automate the extraction process, allowing organizations to efficiently retrieve and utilize GST certificate data.

API details

Endpoint

POST https://api.signzy.app/api/v3/vision/gst-extraction

POST https://api-preproduction.signzy.app/api/v3/vision/gst-extraction

Request Headers

Name	Value	Required	Description
Content-Type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Request body parameters

Parameter	Data Type	Description	Required
files	Array	Individual GST files	Mandatory

Code samples

curl --location 'https://api.signzy.app/api/v3/vision/gst-extraction' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Token>' \
--data '{
  "files": [
    "https://preproduction-persist.signzy.tech/api/files/16995409/download/xxxxxx.pdf"
  ]
}'

Response body parameters

Parameter Name	Data Type	Description
results	Object	The result of the extracted data
results.gstDetails	Object	GST Details extracted from the Document
results.gstDetails.addressOfPrincipalPlaceOfBusiness	Object	All details of the address of the business
results.gstDetails.addressOfPrincipalPlaceOfBusiness.address	String	Full address of the principal place of business
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.address	String	Full address of the principal place of business, duplicated within split address.
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.splitAddress	Object	An object containing split details of the address
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.splitAddress.address	String	Address of the Document holder
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.id	Number	Identifier for the split address.
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.result	Object	Contains the result of the split address.
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.result.splitAddress	Object	Detailed components of the split address.
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.result.splitAddress.district	Array	Array containing district name
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.result.splitAddress.state	Array	Array containing state name and abbreviation.
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.result.splitAddress.city	Array	Array containing city name
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.result.splitAddress.pincode	String	Pincode of the address
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.result.splitAddress.country	Array	Array containing country code and name
results.gstDetails.addressOfPrincipalPlaceOfBusiness.splitAddress.result.splitAddress.addressLine	String	Formatted address line
results.gstDetails.buisnessPlaces	Array	Contains business place details object
results.gstDetails.buisnessPlaces[].address	String	Address of the business place
results.gstDetails.buisnessPlaces[].splitAddress	Object	An object containing split address details for the business place.
results.gstDetails.buisnessPlaces[].splitAddress.address	String	Full address of the business place, duplicated within splitAddress
results.gstDetails.buisnessPlaces[].splitAddress.result	Object	Contains the result of the split address for the business place.
results.gstDetails.buisnessPlaces[].splitAddress.result.splitAddress	Object	Detailed components of the split address for business place.
results.gstDetails.buisnessPlaces[].splitAddress.result.splitAddress.district	Array	Array containing district name.
results.gstDetails.buisnessPlaces[].splitAddress.result.splitAddress.state	Array	Array containing state name and abbreviation.
results.gstDetails.buisnessPlaces[].splitAddress.result.splitAddress.city	Array	Array containing city name.
results.gstDetails.buisnessPlaces[].splitAddress.result.splitAddress.pincode	String	Pincode of the business place address.
results.gstDetails.buisnessPlaces[].splitAddress.result.splitAddress.country	Array	Array containing country code and name.
results.gstDetails.buisnessPlaces[].splitAddress.result.splitAddress.addressLine	String	Formatted address line for business place
results.gstDetails.constitutionOfBusiness	String	Type of business constitution.
results.gstDetails.dateOfIssue	String	Date of GST issue.
results.gstDetails.dateOfLiability	String	Date of GST liability.
results.gstDetails.designation	String	Designation of the person related to the GST account.
results.gstDetails.directorInfo	Array	An array containing information about directors.
results.gstDetails.directorInfo[].resident	String	State of residence of the director.
results.gstDetails.directorInfo[].photo	String	URL of the director's photo.
results.gstDetails.directorInfo[].designation	String	Designation of the director.
results.gstDetails.directorInfo[].name	String	Name of the director.
results.gstDetails.gstNumber	String	GST number.
results.gstDetails.jurisdictionalOffice	String	Code of the jurisdictional office.
results.gstDetails.legalName	String	Legal name associated with the GST account.
results.gstDetails.name	String	Name associated with the GST account.
results.gstDetails.registrationType	String	Type of GST
results.gstDetails.tradeName	String	Trade name of the organization
results.gstDetails.validFrom	String	License validity from.
results.gstDetails.validTo	String	License validity upto.
results.dscDetails	Object	An object containing DSC-related information
results.dscDetails.isSigned	String	Digital Signature Certificate - "Yes" or "No"
results.dscDetails.signatureDetails	Object	Contains the information of signature on the document
results.dscDetails.signatureDetails.documentRevision	Number or NULL	Information about the document revision
results.dscDetails.signatureDetails.doesSignatureCoversFullDocument	Boolean or NULL	Indicates whether the signature covers the full document
results.dscDetails.signatureDetails.totalDocumentRevisions	Number or NULL	Total number of document revisions
results.dscDetails.signatureDetails.certificateInfo	Array	Information about the certificate, including its number, subject, validity, time validity, start date, issuer, and end date
dscDetails.signatureDetails.certificateInfo.certificateNumber	Number	The certificate number associated with the digital signature
dscDetails.signatureDetails.certificateInfo.subject	String	The subject of the certificate
dscDetails.signatureDetails.certificateInfo.certificateValidity	String	Information about the certificate's validity
dscDetails.signatureDetails.certificateInfo.certificateTimeValidity	String	Information about the certificate's time validity
dscDetails.signatureDetails.certificateInfo.validFrom	String	The starting date of certificate validity
dscDetails.signatureDetails.certificateInfo.issuer	String	The entity that issued the certificate
dscDetails.signatureDetails.certificateInfo.validTo	String	The ending date of the certificate validity
results.dscDetails.signatureDetails.IntegrityCheck	Boolean or NULL	Information related to Integrity Check
results.dscDetails.hashcode	Number or NULL	The hashcode associated with the signature
results.dscDetails.name	String	The name associated with the signature
results.dscDetails.signDate	String	The date of the signature
results.dscDetails.signTime	String	The time of the signature

{
    "results": {
        "gstDetails": {
            "addressOfPrincipalPlaceOfBusiness": {
                "address": "[Address]",
                "splitAddress": {
                    "address": "[Address]",
                    "id": 92,
                    "result": {
                        "splitAddress": {
                            "district": [
                                "[District]"
                            ],
                            "state": [
                                [
                                    "[State]",
                                    "[State Abbreviation]"
                                ]
                            ],
                            "city": [
                                "[City]"
                            ],
                            "pincode": "[Pincode]",
                            "country": [
                                "IN",
                                "IND",
                                "INDIA"
                            ],
                            "addressLine": "[Address Line]"
                        }
                    }
                }
            },
            "buisnessPlaces": [{
                "address": "[Business Address]",
                "splitAddress": {
                    "address": "[Business Address]",
                    "result": {
                        "splitAddress": {
                            "district": [],
                            "state": [
                                []
                            ],
                            "city": [],
                            "pincode": "",
                            "country": [],
                            "addressLine": ""
                        }
                    }
                }
            }
            ],
            "constitutionOfBusiness": "Proprietorship",
            "dateOfIssue": "04/10/2017",
            "dateOfLiability": "",
            "designation": "Superintendent",
            "directorInfo": [
                {
                    "resident": "[Director Residence]",
                    "photo": "[Director Photo URL]",
                    "designation": "DIRECTOR",
                    "name": "[Director Name]"
                }
            ],
            "gstNumber": "<GST Number>",
            "jurisdictionalOffice": "MH005",
            "legalName": "[Legal Name]",
            "name": "[Business Name]",
            "registrationType": "Regular",
            "tradeName": "[Trade Name]",
            "validFrom": "04/10/2017",
            "validTo": "NA"
        },
        "dscDetails": {
            "isSigned": "no",
            "signatureDetails": {
                "documentRevision": null,
                "doesSignatureCoversFullDocument": null,
                "totalDocumentRevisions": null,
                "certificateInfo": [
                    {
                        "certificateNumber": 0,
                        "subject": "",
                        "certificateValidity": "",
                        "certificateTimeValidity": "",
                        "validFrom": "",
                        "issuer": "",
                        "validTo": ""
                    }
                ],
                "IntegrityCheck": null
            },
            "hashcode": null,
            "name": "",
            "signDate": "",
            "signTime": ""
        }
    }
}

For best results, make sure the image you use fits tightly in the camera view and is horizontally aligned.

Supported document types:

Image: JPEG, JPG, PNG, TIFF or TIF, and PDFs.

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!