PTRC

7 min

Introduction

This API allows users to fetch PTRC(Professional Tax Registration Certificate) data.

How to call the API

You are required to pass the access token received from the login call to the authorization header of the request.

API Input Guidelines

You need to pass the professionalTaxNumber and state in the request body and access token received from login in the respective authorization header.

Sample Curl

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/...patronId.../ptrcs' \
--header 'Content-Type: application/json' \
--header 'Authorization: ...Authorization token...' \
--data '{
    "essentials": {
        "professionalTaxNumber": "...professionalTaxNumber...",
        "state": "...state..."
    }
}'

Input Parameters

PARAMETER NAME	DESCRIPTION
Authorization	Access Token for authentication and authorization
Content-Type	Specifies the format of the data sent in the request body
essentials	Contains the essential input data
essentials.professionalTaxNumber	Professional Tax Number details to search for
essentials.state	State associated with the Professional Tax Number

Sample Response

{
    "essentials": {
        "professionalTaxNumber": "...professionalTaxNumber...",
        "state": "...state..."
    },
    "id": "...id...",
    "patronId": "...patronId...",
    "result": {
        "address1": "...address1...",
        "address2": "...address2...",
        "address3": "...address3...",
        "talukaName": "...talukaName...",
        "streetName": "...streetName...",
        "pinCode": "...pinCode...",
        "districtName": "...districtName...",
        "cityName": "...cityName...",
        "effectiveOrCanceledDate": "...effectiveOrCanceledDate...",
        "address": "...address...",
        "status": "...status...",
        "state": "...state...",
        "tin": "...tin...",
        "principalAddress": "...principalAddress...",
        "dealerStatus": "...dealerStatus...",
        "gstin": "...gstin...",
        "dealerName": "...dealerName...",
        "splitAddress": {
            "district": [],
            "state": [
                []
            ],
            "city": [],
            "pincode": "...pincode...",
            "country": [
                "IN",
                "IND",
                "INDIA"
            ],
            "addressLine": "...addressLine..."
        },
        "dataFromGstn": {
            "gstnDetailed": {
                "constitutionOfBusiness": "...constitutionOfBusiness...",
                "legalNameOfBusiness": "...legalNameOfBusiness...",
                "tradeNameOfBusiness": "...tradeNameOfBusiness...",
                "centreJurisdiction": "...centreJurisdiction...",
                "stateJurisdiction": "...stateJurisdiction...",
                "registrationDate": "...registrationDate...",
                "taxPayerDate": "...taxPayerDate...",
                "gstinStatus": "...gstinStatus...",
                "cancellationDate": "...cancellationDate...",
                "natureOfBusinessActivities": [],
                "principalPlaceAddress": "...principalPlaceAddress...",
                "principalPlaceBuildingNoFromGST": "...principalPlaceBuildingNoFromGST...",
                "principalPlaceBuildingNameFromGST": "...principalPlaceBuildingNameFromGST...",
                "principalPlaceFlatNo": "...principalPlaceFlatNo...",
                "additionalPlaceAddress": "...additionalPlaceAddress...",
                "additionalPlaceBuildingNoFromGST": "...additionalPlaceBuildingNoFromGST...",
                "additionalPlaceBuildingNameFromGST": "...additionalPlaceBuildingNameFromGST...",
                "additionalPlaceFlatNo": "...additionalPlaceFlatNo...",
                "additionalPlaceSplitAddress": {
                    "district": [],
                    "state": [
                        []
                    ],
                    "city": [],
                    "pincode": "...pincode...",
                    "country": [],
                    "addressLine": "...addressLine..."
                },
                "principalPlaceSplitAddress": {
                    "district": [],
                    "state": [
                        []
                    ],
                    "city": [],
                    "pincode": "...pincode...",
                    "country": [],
                    "addressLine": "...addressLine..."
                }
            },
            "gstnRecords": [
                {
                    "applicationStatus": "...applicationStatus...",
                    "registrationName": "...registrationName...",
                    "mobNum": "...mobNum...",
                    "regType": "...regType...",
                    "emailId": "...emailId...",
                    "tinNumber": "...tinNumber...",
                    "gstinRefId": "...gstinRefId...",
                    "gstin": "...gstin..."
                }
            ],
            "gstin": "...gstin...",
        }
    }
}

Output Parameters

PARAMETER NAME	DESCRIPTION
essentials	Contains "essentials" key of the request body
essentials.professionalTaxNumber	Professional Tax Number details to search for
essentials.state	State associated with the Professional Tax Number
id	Unique id of user
patronId	Unique patronId of user
result	The resulting json object containing search results
result.address1	First address
result.address2	Second address
result.address3	Third address
result.talukaName	Name of taluka
result.streetName	Name of street
result.pinCode	Pincode
result.districtName	Name of district
result.cityName	Name of city
result.effectiveOrCanceledDate	Effective or Cancelled date
result.address	Full Address
result.status	Status
result.state	State
result.tin	Tin number
result.principalAddress	Principal Address
result.dealerStatus	Status of dealer
result.gstin	GSTIN number
result.dealerName	Name of dealer
result.address	The full address including street address, city, state, pincode and country
result.splitAddress	A json object containing a breakdown of the address into individual components
result.splitAddress.district	An array of districts
result.splitAddress.state	An array of states
result.splitAddress.city	An array of cities
result.splitAddress.pincode	The pincode
result.splitAddress.country	An array of countries
result.splitAddress.addressLine	The street address
result.dataFromGstn	Data object from GSTN
result.dataFromGstn.gstnDetailed	GSTN detailed data
result.dataFromGstn.gstnDetailed.constitutionOfBusiness	Constitution of business
result.dataFromGstn.gstnDetailed.legalNameOfBusiness	Legal Name of business
result.dataFromGstn.gstnDetailed.tradeNameOfBusiness	Trade Name of business
result.dataFromGstn.gstnDetailed.centreJurisdiction	Centre jurisdiction
result.dataFromGstn.gstnDetailed.stateJurisdiction	State jurisdiction
result.dataFromGstn.gstnDetailed.registrationDate	Registration date
result.dataFromGstn.gstnDetailed.taxPayerDate	Tax payer date
result.dataFromGstn.gstnDetailed.gstinStatus	GSTIN status
result.dataFromGstn.gstnDetailed.cancellationDate	Cancellation date
result.dataFromGstn.gstnDetailed.natureOfBusinessActivities	Nature of business activities
result.dataFromGstn.gstnDetailed.principalPlaceAddress	Principal place address
result.dataFromGstn.gstnDetailed.principalPlaceBuildingNoFromGST	Principal place building number from gst
result.dataFromGstn.gstnDetailed.principalPlaceBuildingNameFromGST	Principal place building name from gst
result.dataFromGstn.gstnDetailed.principalPlaceFlatNo	Principal place flat number
result.dataFromGstn.gstnDetailed.additionalPlaceAddress	Additional place address
result.dataFromGstn.gstnDetailed.additionalPlaceBuildingNoFromGST	Additional place building number from gst
result.dataFromGstn.gstnDetailed.additionalPlaceBuildingNameFromGST	Additional place building name from gst
result.dataFromGstn.gstnDetailed.additionalPlaceFlatNo	Additional place flat number
result.dataFromGstn.gstnDetailed.additionalPlaceSplitAddress	Additional place split address
result.dataFromGstn.gstnDetailed.additionalPlaceSplitAddress.district	Additional place split address district
result.dataFromGstn.gstnDetailed.additionalPlaceSplitAddress.state	Additional place split address state
result.dataFromGstn.gstnDetailed.additionalPlaceSplitAddress.city	Additional place split address city
result.dataFromGstn.gstnDetailed.additionalPlaceSplitAddress.pincode	Additional place split address pincode
result.dataFromGstn.gstnDetailed.additionalPlaceSplitAddress.pincode	Additional place split address pincode
result.dataFromGstn.gstnDetailed.additionalPlaceSplitAddress.addressLine	Additional place split address addressLine
result.dataFromGstn.gstnDetailed.principalPlaceSplitAddress.district	Principal place split address district
result.dataFromGstn.gstnDetailed.principalPlaceSplitAddress.state	Principal place split address state
result.dataFromGstn.gstnDetailed.principalPlaceSplitAddress.city	Principal place split address city
result.dataFromGstn.gstnDetailed.principalPlaceSplitAddress.pincode	Principal place split address pincode
result.dataFromGstn.gstnDetailed.principalPlaceSplitAddress.country	Principal place split address country
result.dataFromGstn.gstnDetailed.principalPlaceSplitAddress.addressLine	Principal place split address addressLine
result.dataFromGstn.gstnRecords	GSTN records
result.dataFromGstn.gstnRecords[index].applicationStatus	Application status from gstn record
result.dataFromGstn.gstnRecords[index].registrationName	Registraion name from gstn record
result.dataFromGstn.gstnRecords[index].mobNum	Mobile number from gstn record
result.dataFromGstn.gstnRecords[index].regType	Registration Type from gstn record
result.dataFromGstn.gstnRecords[index].emailId	Email id from gstn record
result.dataFromGstn.gstnRecords[index].tinNumber	Tin number from gstn record
result.dataFromGstn.gstnRecords[index].gstinRefId	GSTIN referernce id from gstn record
result.dataFromGstn.gstnRecords[index].gstin	GSTIN number from gstn record
result.dataFromGstn.gstin	GSTIN number

Status Codes

CODE	MESSAGE
200	OK
404	professionalTaxNumber not found
400	Invalid Data

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].