eStamping & DocSigner API

Introduction

The All-in-One Document Authentication API is a comprehensive solution that seamlessly integrates multiple essential document processing functionalities into a single, robust API. This powerful tool is designed to enhance efficiency, ensure legal compliance, and simplify the management of electronic documents. Here’s a detailed description of the integrated functionalities:

eStamping The eStamping feature simplifies the process of affixing stamp paper to documents, ensuring legal compliance with ease. Users can provide the required PDF and stamp paper details in the input, and the API efficiently generates an output PDF with the stamp paper accurately affixed and defaced for added security. The API also allows for the inclusion of unique headers in API calls, facilitating precise response tracking and improved integration into existing systems. This functionality ensures that document processing is seamless, efficient, and legally compliant.

DocSigner Class 2 and Class 3 The DocSigner functionality revolutionizes electronic document signing by incorporating Document Signer Certificates Class 2 and Class 3. This API allows users to seamlessly integrate digital signatures into their document workflows, leveraging the advanced security of Class 2 and Class 3 certificates. The DocSigner API offers complete customization of the signing process, enabling users to precisely position the signature within the document to meet specific requirements. This enhances the efficiency, security, and compliance of document signing, providing a robust solution for electronic signatures.

Company Seal and Virtual esign The Virtual eSign and SEAL feature enables users to utilize pre-saved Authorized Person’s signatures and company seal stamps. By consuming certificate IDs of the stored signatures and seals, the API automatically applies them to the provided contract file at specified coordinates. The final output is a signed and sealed PDF, ensuring streamlined document processing and legal compliance.

Authentication

API authentication is a crucial security process that ensures authorized access to an application programming interface (API). It involves validating the identity of users or systems seeking to interact with the API. Please use the access token shared with you by your assigned Signzy's CSM. Please set the value of the key Authorization in the headers to the access token, while making an API call. In this way, Signzy's system will be able to authenticate you and you will be able to make a successful API call.

API Details

Sample cURL

curl --location 'https://api.signzy.app/api/v3/contract/eStampingAndDocSigner' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'x-uniqueReferenceId: XXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data '{
    "pdf": "",
    "endOfLife": 19739,
    "estamp": {
        "type": "ESTAMP",
        "customDefacement": "Stamp duty of Rspaid via Stamp Paper Certificate No {{certificateNo}}",
        "location": "CUSTOMIZE",
        "xCoordinate": "10",
        "yCoordinate": "10",
        "secondPartyName": "B",
        "firstPartyName": "ABCLS",
        "stampDutyPaidBy": "B",
        "considerationPrice": "50",
        "stampDetails": [
            {
                "stateCode": "KA",
                "articleCode": "KA",
                "stampDutyValue": "10",
                "count": 1,
                "purposeOfStampDuty": "test"
            },
            {
                "stateCode": "MP",
                "articleCode": "KA",
                "stampDutyValue": "10",
                "count": 1,
                "purposeOfStampDuty": "test"
            }
        ]
    }
}'

Header Parameters

key	Type	M/o	Description
x-uniqueReferenceId	String	Optional	Unique reference id for each API request. It needs to be generated at client's end and passed in API. It can further be used in eStamp & DocSigner query API to get the succesful reponses of the API call.

Input Parameters (estamp)

Parameter Name	Type	Mandatory/Optional	Description
pdf	String	Mandatory	Mandatory Pass the document to be signed in below formats - URL of the PDF file
additionalFiles	Array	Optional	This parameter accepts an array of strings, Pass the URLs or Base64 encoded string value of the PDF file you want to append with the main file.
type	String	Mandatory	You want to use estamp or eChallan. Please pass "ESTAMP" if you want to use eStamp method
customDefacement	String	Optional	If passed, custom defecement will be enabled. text for custom defacement can contain variables. The variable should be enclosed in {{}} and can be one from below: Estamp: {{certificateNo}}{{certificateDate}} {{uniqueDocRef'}} {{firstPartyName'}} {{stateCode'}},{{articleCode'}} {{denomination}} {{secondPartyName}} {{stampDutyPaidBy}} {{'purposeOfStampDuty'}}
secondPartyName	String	Mandatory	Name of second party involved in the transactiton
firstPartyName	String	Mandatory	Name of first party involved in the transaction
stampDutyPaidBy	String	Mandatory	Name of the party who paid the stamp duty(first party or second party)
stampDetails	Array Of Objects	Mandatory	Details of the stamp papers which needs to be stamped on the document
stateCode	String	Mandatory	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"]
articleCode	String	Mandatory	Article Code for E-stamping
stampDutyValue	String	Mandatory	Amount of the stamp duty
count	String	Mandatory	Count of the stamp papers that needs to be used
dynamicStampConsumption	Boolean	Optional	If true is passed, dynamic eStamping will be enabled for that particular stamp statecode, articlecode and stamp duty. Note: You can either pass count OR dynamicStampConsumption as True. If both are not passed, Then be default, count as one will be considered.
lossCap	Number	Optional (By default as 0)	In case of dnyamic stamping, losscap represents the maxium amount of loss, for example, if the amount passed in stamp is INR 1203 and loss cap is 97, so we can get a stamp paper with a maximum value of 1300 (1203+97)
mergeLimit	Number	Optional (By default - No limit)	In case of dynamic stamping, mergeLimit reprsents the maximum number of stamp paper which should be clubbed to get to the amount of stamp value
purposeOfStampDuty	String	Mandatory	Purpose of stamp duty
considerationPrice	String	Mandatory	Amount of fund involved in the transaction
location	String	Optional (By default bottomLeft)	location of defacement. available option : topLeft, topCenter, middleLeft, middleCenter, bottomLeft, bottomCenter, customize
xCoordinate	Number	Mandatory if location passed as customize	x coordinate for defacement
yCoordinate	Number	Mandatory if location passed as customize	y coordinate for defacement

Input Parameters (echallan)

Parameter Name	Type	Mandatory/Optional	Description
pdf	String	Mandatory	Mandatory Pass the document to be signed in below formats - URL of the PDF file
additionalFiles	Array	Optional	This parameter accepts an array of strings, Pass the URLs or Base64 encoded string value of the PDF file you want to append with the main file.
type	String	Mandatory	You want to use estamp or eChallan. Please pass "ECHALLAN" if you want to use echallan method
customDefacement	String	Optional	If passed, custom defecement will be enabled. text for custom defacement can contain variables. The variable should be enclosed in {{}} and can be one from below: Echallan: {{challanNo}},{{challanDate}},{{stateCode}},{{firstPartyName}},{{articleCode}},{{amount}},{{secondPartyName}},{{purposeOfStampDuty}},{{stampDutyPaidBy}}
secondPartyName	String		Name of second party involved in the transactiton
firstPartyName	String		Name of first party involved in the transaction
stampDutyPaidBy	String		Name of the party who paid the stamp duty(first party or second party)
stampDetails	Array Of Objects	Mandatory	Details of the stamp papers which needs to be stamped on the document
stampDetails.stateCode	String	Mandatory	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"]
stampDetails.articleCode	String	Mandatory	Article Code for E-stamping
stampDetails.stampDutyValue	String	Mandatory	Amount of the stamp duty
stampDetails.count	String	Mandatory	Count of the stamp papers that needs to be used
stampDetails.purposeOfStampDuty	String	Mandatory	Purpose of stamp duty
considerationPrice	String	Mandatory	Amount of fund involved in the transaction
pageNo	Array	Optional(By default first page)	Page no on which defacement is needed.
location	String	Optional (By default bottomLeft)	location of defacement. available option : topLeft, topCenter, middleLeft, middleCenter, bottomLeft, bottomCenter, customize
xCoordinate	Number	Mandatory if location passed as customize	x coordinate for defacement
yCoordinate	Number	Mandatory if location passed as customize	y coordinate for defacement

Input Parameters (DocSigner)

Parameter Name	Type	Mandatory/Optional	Description
pdf	String	Mandatory	Pass the document to be signed in below formats - URL of the PDF file Base64 of the PDF file
additionalFiles	Array	Mandatory	This parameter accepts an array of strings, Pass the URLs or Base64 encoded string value of the PDF file you want to append with the main file.
endOfLife	Number	Conditionally Mandatory	Mandatory for Docsigner Usage. Optional Incase of eStamping Usage, if not passed, default value of 6 months will be considered. Accepts value in seconds. You can set the time period for which documents should be stored in Signzy system. Post this period, documents will be removed from Signzy system. Maximum value can be 15552000.
signatureOptions	String	Mandatory	Pass either of the below 2 supported signature options - docSignerClass2 docSignerClass3 VIRTUALESIGN SEAL
certificateId	String	Conditionally Mandatory	Pass the certificate ID of docSignerClass2 or docSignerClass3or VIRTUALESIGN or SEAL whichever you want to use to sign the document. CertificateID can be generated by using UploadDocSignConfig API.
signatures	Array of Objects	Mandatory	An array of signature objects where the signatures will be placed
signatures.pageNo	Array	Mandatory	Array of page numbers to specify where the signature(s) should be placed. Note - In case where signature needs to be placed on all pages, pass the value ALL In case where signature needs to be placed on all pages, pass the value LAST
signatures.signaturePosition	String	Mandatory	Position for the signature on the specified page. It will accept the following values - TOPLEFT TOPCENTER TOPRIGHT MIDDLELEFT MIDDLECENTER MIDDLERIGHT BOTTOMLEFT BOTTOMCENTER BOTTOMRIGHT CUSTOMIZE In case of passing the value "CUSTOMIZE", the xCoordinate, yCoordinate, height and width must be passed
signatures.xCoordinate	Array of Numbers	Conditionally Mandatory	X-coordinate for the specified signature placement.
signatures.yCoordinate	Array of Numbers	Conditionally Mandatory	Y-coordinate for the specified signature placement.
signatures.height	Number	Conditionally Mandatory	Height of the signature box for the specified page. The minimum value is 70(pixels). If no value is provided or a value less than 70 is passed, it will be set to the default height of 70.
signatures.width	Number	Conditionally Mandatory	Width of the signature box for the specified page. The minimum value is 130(pixels). If no value is provided or a value less than 130 is passed, it will be set to the default width of 130.
logoUrl	String	Mandatory	URL of the logo of the client which will be used in the sign that will appear on the signed pdf file. It can have 3 allowed formats - PNG (.png) JPG (.jpg) JPEG (.jpeg)
reason	String	Optional	Only applicale in cases of Doc Signer Class 3. You can pass a reason for the signing You can remove this from the request body if you are using Doc Signer Class 2.
location	String	Optional	Only applicale in cases of Doc Signer Class 3. You can pass a location for the signing. For example, Bangalore. You can remove this from the request body if you are using Doc Signer Class 2.

Sample Response

{
    "pdf": "",
    "stampedPdf": "",
    "refId": "669e5f292f790187102ea25b",
    "x-uniqueReferenceId": "Std-157"
}

Output Parameters

Parameter Name	Type	Description
pdf	String	The input PDF document to be stamped
signatureOptions	String	4 supported signature options - docSignerClass2 docSignerClass3 SEAL VIRTUALESIGN
stampedPdf	String	The signed PDF document after eStamping
signedPdf	String	The signed PDF document after docsigner (if eStamping is passed as well, signed PDF will also be eStamped)
refId	String	Signzy generated unique transaction ID for the API response.
x-uniqueReferenceId	String	Unique reference id for each API request. It needs to be generated at client's end and passed in API. It can further be used in eStamp and DocSigner Query API to get the reponse of the succesful API call.

Sample Errors

{
    "name": "error",
    "message": "Error from upstream in signing of the document with the given inputs for Document Signer Certificate Class3 method",
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": 409
}

Error Codes

Error Code	Error Message	Explanation
400	Bad Request	Input parameter has a missing required parameter or invalid inputs
401	Authorization Failed	Authorization token is invalid
409	Upstream Error	Error from the upstream while doing the signing
500	Internal Server Error	Internal error at Signzy, Please reach out to [email protected]