Request Estamp

15 min

Introduction

Request Estamp API can be used by any customer to request the estamp which was already procured for them. This API accepts the below-mentioned parameters as an input and returns the response based on whether the stamp is already procured or not.

If it is procured you get a transactionId as a repsonse which you can further use to know the status of your request.

If it is not already procured you will get a message : You do not have stamps available for given denominations in your wallet. Please procure stamps

How to call the API

You will need to log in before sending the request. You are required to pass the access token received from the login call, as the authorization header in the request.

API Input Guidelines

Make sure you replace ..your-patron-id.. in the URL with the patronId that you receive from the login call and also make sure you pass in all the necessary input parameters in the correct format.

Sample Curl

Preproduction

Production

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..your-patron-id../estamping' \
--header 'Authorization: <Auth Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
        "task": "eStamp",
        "essentials": {
            "stateCode": "...stateCode...",
            "firstPartyName": "...firstPartyName...",
            "secondPartyName": "...secondPartyName...",
            "considerationPrice": "...considerationPrice...",
            "stampDutyPaidBy": "...stampDutyPaidBy...",
            "stampDutyValue": "...stampDutyValue...",
            "purposeOfStampDuty": "...purposeOfStampDuty...",
            "articleCode": "...articleCode...",
            "pdfUrl": "...pdfUrl...",
            "callbackUrl": "...callbackUrl..."
        }
    }'

curl --location --request POST 'https://signzy.tech/api/v2/patrons/...patronID.../estamping' \
--header 'Authorization: <Auth Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
        "task": "eStamp",
        "essentials": {
            "stateCode": "...stateCode...",
            "firstPartyName": "...firstPartyName...",
            "secondPartyName": "...secondPartyName...",
            "considerationPrice": "...considerationPrice...",
            "stampDutyPaidBy": "...stampDutyPaidBy...",
            "stampDutyValue": "...stampDutyValue...",
            "purposeOfStampDuty": "...purposeOfStampDuty...",
            "articleCode": "...articleCode...",
            "pdfUrl": "...pdfUrl...",
            "callbackUrl": "...callbackUrl..."
        }
    }'

Input Parameters

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
stateCode	state code of the states where estamps are valid. Possible values : ["KA", "MH", "GJ", "AP", "AN", "AS", "BR", "CT", "CH", "DN", "DD", "DL", "HP", "JK", "JH", "LA", "OR", "PY", "RJ", "TN", "TR", "UP", "UT", "PB", "WB", "GA", "HR", "KL", "MN", "ML", "MZ", "NL", "LD", "SK", "AR", "TG", "MP"]	string	Mandatory
pdfUrl	url of the pdf file	string	Mandatory
callbackUrl	customer callback where the final result will be posted	string	Mandatory
firstPartyName	name of first party involved in the transaction	string	Mandatory
secondPartyName	name of second party involved in the transactiton	string	Mandatory
stampDutyValue	amount of the stamp duty	string	Mandatory
purposeOfStampDuty	purpose of stamp duty	string	Mandatory
considerationPrice	amount of fund involved in the transaction	string	Mandatory
articleCode	article Code for E-stamping	string	Mandatory
stampDutyPaidBy	name of the party who paid the stamp duty	string	Mandatory
fileTtl	ttl of the estamped pdf from response (By default 10 mins; For possible values check File Exchange Page)	string	Optional

Valid States and State Codes

STATE	STATECODE
Karnataka	KA
Maharastra	MH
Gujarat	GJ
Andhra Pradesh	AP
Andaman and NIcobar Islands	AN
Assam	AS
Bihar	BR
Chhattisgarh	CT
Chandigarh	CH
Dadra and Nagar Haveli	DN
Daman and Diu	DD
Delhi	DL
Himachal Pradesh	HP
Jammu and Kashmir	JK
Jharkhand	JH
Ladakh	LA
Orissa	OR
Pondicherry	PY
Rajasthan	RJ
Tamil Nadu	TN
Tripura	TR
Uttar Pradesh	UP
Uttarakhand	UT
Punjab	PB
West Bengal	WB
Goa	GA
Haryana	HR
Kerala	KL
Manipur	MN
Meghalaya	ML
Mizoram	MZ
Nagaland	NL
Lakshadweep	LD
Sikkim	SK
Arunachal Pradesh	AR
Telangana	TG
Madhya Pradesh	MP

Article Codes

You can download the below csv file to check all possible article codes which varies from state to state and depend on the transaction that you are involved in

articleCode.csv

Sample CSV format

name	isActive	articleCode	stateCode
Acknowledgement [1]	0	KA1001	KA
Administration Bond [2]	0	KA1002	KA
Adoption Deed [3]	0	KA1003	KA
Affidavit [4]	1	KA1004	KA

In order to find the exact article code, one needs to check the corresponding stateCode and then look into the name column to identify the type of transaction for which one needs to generate an estamp.

Sample Response

(i) If the estamp is procured for the input parameters that you have provided

{
    "result": {
        "transactionId": "...transactionId..."
    }
}

(i) If the estamp is not procured for you

{
    "result": {
        "message": "You do not have stamps available for given denominations in your wallet. Please procure stamps"
    }
}

Response Parameter

PARAMETER NAME	DESCRIPTION
transactionId	This is the id that you can use in Get Estamp Status API to know the status of your estamp.

Sample Error

{
  "error": {
    "statusCode": 400,
    "name": "error",
    "message": "stampDutyPaidBy must match either to firstPartyName or secondPartyName",
    "status": 400
  }
}

Error Parameter

PARAMETER NAME	DESCRIPTION
error	This parameter contains the error.
error.name	the name of the error
error.message	the error message
error.status	status of the api
error.statusCode	Request Status code from Signzy

Error Codes

CODE	DESCRIPTION	INTERPRETATION
400	Bad Request	Input Parameter has a missing required parameter or not a valid one
401	Authorization Failed	Authorization token is invalid.
500	Internal Server Error	Internal error at Signzy, please contact support.

Callback URL

If a customer provide a valid callback URL in the input request the final data will be posted on the CallbackURL. The "transactionId" as received in the response of the /estamping request can be used as a reference key to the data as received in the callback from Signzy. The data will be posted to callback within a maximum duration of 5 mins.

Sample Response posted to callback

{
        "transactionId": "...transactionId...",
        "result": {
            "certificateNumber": "...certificateNumber...",
            "certificateReferenceNumber": "...certificateReferenceNumber...",
            "eStampedFile": "...eStampedFile..."
        }
    }

Callback Parameters

PARAMETER NAME	DESCRIPTION
transactionId	this id can be used a reference key to access the data received in the callbackURL.
certificateNumber	A certificate number is typically a unique identifier assigned to a specific estamp certificate or document, to help identify it among others.
certificateReferenceNumber	may be a unique identifier used to track or reference a particular estamp transaction or submission.
eStampedFile	URL of the final output file where the first page would be consisting of estamp and the further pages consists of the pdf url that you have passed as an input parameter.

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].