eStamping Standalone 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 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 pre production (estamp) curl location 'https //api preproduction 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", "dynamicstampconsumption" true, "purposeofstampduty" "test" }, { "statecode" "mp", "articlecode" "ka", "stampdutyvalue" "10", "dynamicstampconsumption" true, "losscap" 50, "mergelimit" 2, "purposeofstampduty" "test" } ] } }' pre production (echallan) curl location 'https //api preproduction signzy app/api/v3/contract/estampinganddocsigner' \\ \ header 'authorization xxxxxxxxxxxxxxxxxxxxxxxx' \\ \ header 'x uniquereferenceid xxxxxxxxxx' \\ \ header 'content type application/json' \\ \ data '{ "pdf" "", "additionalfiles" \["",""], "estamp" { "type" "echallan", "secondpartyname" "c", "firstpartyname" "bhagyesh", "statecode" "ka", "articlecode" "ka", "stampdutypaidby" "c", "purposeofstampduty" "nothing", "amount" 10, "pageno" \[ 2 ], "location" "customize", "xcoordinate" "10", "ycoordinate" "10", "stampdutyvalue" "10", "customdefacement" "" } }' production(estamps) 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", "dynamicstampconsumption" true, "purposeofstampduty" "test" }, { "statecode" "mp", "articlecode" "ka", "stampdutyvalue" "10", "dynamicstampconsumption" true, "losscap" 50, "mergelimit" 2, "purposeofstampduty" "test" } ] } }' production (echallan) 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, "additionalfiles" \["",""], "estamp" { "type" "echallan", "secondpartyname" "c", "firstpartyname" "bhagyesh", "statecode" "ka", "articlecode" "ka", "stampdutypaidby" "c", "purposeofstampduty" "nothing", "amount" 10, "pageno" \[ 2 ], "location" "customize", "xcoordinate" "10", "ycoordinate" "10", "stampdutyvalue" "10", "customdefacement" "" } }' 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" "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" "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 output parameters parameter name type description pdf string the input pdf document to be stamped stampedpdf string the signed pdf document after estamping refid string signzy generated unique transaction id for the api response sample errors 400 { "name" "error", "message" "duplicate uniquereferenceid cannot complete the process ", "reason" "error", "type" "bad request", "statuscode" 400 } 400 { "name" "error", "message" "you do not have stamps available for given denominations in your wallet please upload estamps ", "reason" "validation error", "type" "bad request", "statuscode" 400 } 400 { "name" "error", "message" "enter a valid location", "reason" "validation error", "type" "bad request", "statuscode" 400 } 401 { "message" "invalid authentication credentials" } 400 { "name" "error", "message" "docsignerclass3certificatevalues is not allowed", "reason" "validation error", "type" "bad request", "statuscode" 400 } 400 { "name" "error", "message" "signatures is not allowed", "reason" "validation error", "type" "bad request", "statuscode" 400 } 400 { "name" "error", "message" "signatures\[0] signatureposition\[0] must be one of \[topleft, topcenter, topright, middleleft, middlecenter, middleright, bottomleft, bottomcenter, bottomright, customize]", "reason" "validation error", "type" "bad request", "statuscode" 400 } 409 { "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 help\@signzy com