Contract360 Workflow
Initiate Contract API
24 min
introduction welcome to the initiate contract api, your gateway to effortlessly streamline and orchestrate the process of creating and managing contracts within your application this comprehensive guide will walk you through the seamless integration of this api, empowering you to initiate contracts, define signers, customize contract parameters, and efficiently manage callback urls with the power of this api at your fingertips, you can seamlessly orchestrate complex contract workflows while ensuring a smooth and user friendly experience for all parties involved by leveraging the initiate contract api, you can easily upload your contract files, specify signer details, define callback urls, and even customize various aspects of the contract to align with your specific requirements the api harnesses the capability to dynamically generate signing urls for each signer, providing a direct and secure path for individuals to engage with and sign the contract digitally whether you're a developer looking to enhance your application's contract management capabilities or a business seeking a sophisticated and streamlined way to engage signers, the initiate contract api offers a powerful solution that seamlessly integrates into your existing infrastructure join us as we delve into the details of how to leverage the initiate contract api to empower your application with the ability to effortlessly initiate, manage, and facilitate the signing of contracts, ensuring a frictionless and secure contract execution process for all stakeholders involved let's embark on this journey to revolutionize the way contracts are managed and executed within your ecosystem 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 the details of the api can be found here sample curl pre production curl location 'https //api preproduction signzy app/api/v3/contract/initiate' \\ \ header 'authorization ' \\ \ header 'content type application/json' \\ \ header 'x uniquereferenceid ' \\ \ data '{ "pdf" " ", "templatedetails" { "templateid" " ", "jsondata" { "day" "sample text data", "month" "sample text data", "distributorbusinessname" "sample text data", "distributorbusinessaddress" "sample text data", "distributorname" "sample text data" } }, "persistauthkey" " ", "smtpcredentials" { "smtpfromname" " ", "smtpurl" " ", "smtpport" " ", "smtpusername" " ", "smtppassword" " " }, "customsendinglogic" { "url" " ", "event" \[ "otp verification", "contract initiation", "signer confirmation", "final confirmation", "reminder", "reviewer mail" ], "header" "" }, "contractname" "savings account opening form", "contractexecutername" "signzy", "successredirecturl" "https //signzy com", "failureredirecturl" "https //google com", "contractttl" 10000, "callbackurl" "", "callbackurlauthorizationheader" "", "signercallbackurl" "", "signercallbackurlauthorizationheader" "", "namematchthreshold" "0 50", "allowsignergendermatch" true, "allowsigneryobmatch" true, "allowuidlastfourdigitsmatch" true, "allowpincodematch" true, "crossotpverification" true, "emudhracustomization" { "logourl" "", "headercolour" "", "buttoncolour" "", "maskedaadhaarfield" "", "secondarybuttoncolour" "", "pagebackgroundcolour" "", "pagetextcolour" "", "footerbackgroundcolour" "", "footertextcolour" "", "successtextcolour" "", "errortextcolour" "", "errorbackgroundcolour" "", "linktextcolour" "", "infoiconcolour" "", "textfieldbordercolour" "" }, "signerdetail" \[ { "signername" "mayank", "signermobile" "", "signeremail" "", "signergender" "male", "uidlastfourdigits" "", "pincode" "", "signeryearofbirth" "", "signeruniqueid" "", "signaturetype" "aadhaaresign otp", "cancelbysigner" true, "digitalconsent" { "consentdata" \[ { "text" "i confirm that i have opted for debit card", "required" false }, { "text" "i agree to comply with applicable laws", "required" true } ], "consentheading" "terms & conditions" }, "additionalsignaturetypes" \[ "aadhaaresign fingerprint" ], "postverification" \[ "otp","videoverification" ], "timer" 5, "matchscript" "my name is xyz, i agree to comply with applicable laws", "signatures" \[ { "pageno" \[ "all" ], "signatureposition" \[ "bottomleft" ] } ] }, { "signername" "ashish", "signermobile" "", "signeremail" "", "signergender" "female", "uidlastfourdigits" "", "pincode" "", "signeryearofbirth" "", "signeruniqueid" "", "signaturetype" "smartesign", "cancelbysigner" true, "organizationname" "", "preverification" \[ "livenessverification","otp","imagecapture" ], "matchimage" \[" "], "matchimagethreshold" "", "additionalchecks" true, "allowiflivenessfails" true, "allowiffacematchfails" true, "additionalsignaturetypes" \[ "aadhaaresign fingerprint" ], "signatures" \[ { "pageno" \[ 11, 2, 5 ], "signatureposition" \[ "topleft", "customize" ], "xcoordinate" \[ 300, 5 ], "ycoordinate" \[ 400, 5 ] }, { "pageno" \[ 1, 2, 5 ], "signatureposition" \[ "topleft", "customize" ], "xcoordinate" \[ 300, 5 ], "ycoordinate" \[ 400, 5 ] } ] } ], "docsigner" \[ { "signatureoptions" "docsignerclass3", "certificateid" "", "signingstep" "start", "location" "bangalore", "reason" "testing", "signatures" \[ { "pageno" \[ "all" ], "signatureposition" \[ "topleft" ] }, { "pageno" \[ 2 ], "signatureposition" \[ "customize" ], "xcoordinate" \[ 100 ], "ycoordinate" \[ 50 ] } ] }, { "signatureoptions" "docsignerclass2", "certificateid" "", "signingstep" "start", "location" "bangalore", "reason" "testing", "signatures" \[ { "pageno" \[ "all" ], "signatureposition" \[ "topright" ], "height" 70, "width" 130 }, { "pageno" \[ 2 ], "signatureposition" \[ "customize" ], "xcoordinate" \[ 300 ], "ycoordinate" \[ 50 ] } ] }, { "signatureoptions" "seal", "certificateid" " ", "signingstep" "end", "signatures" \[ { "pageno" \[ 5 ], "signatureposition" \[ "bottomleft", "bottomcenter" ], "height" 100, "width" 50 } ] }, { "signatureoptions" "virtualesign", "certificateid" " ", "signingstep" "start", "signatures" \[ { "pageno" \[ 2 ], "signatureposition" \[ "middleleft", "middlecenter" ] } ] } ], "workflow" true, "isparallel" false, "redirecttime" 5, "locationcapturemethod" "ip", "initiationemailsubject" "please sign the document received on your email", "customermaillist" \[ "" ], "customermaillistvisibility" "cc/bcc" "adminmaillist" \["admin1\@test com", "admin1\@test com"], "estamp" { "type" "echallan", "statecode" "", "articlecode" "", "firstpartyname" "", "secondpartyname" "", "stampdutypaidby" "", "purposeofstampduty" "", "stampdutyvalue" "", "considerationprice" "", "amount" "", "pageno" "", "location" "", "customdefacement" "", }, "estamp" { "type" "estamp", "firstpartyname" "abcls", "secondpartyname" "komal", "stampdutypaidby" "abcls", "considerationprice" "" "customdefacement" "", "stampdetails" \[ { "statecode" "ka", "articlecode" "ka1005", "stampdutyvalue" 100, "purposeofstampduty" "test", "dynamicstampconsumption" true, "losscap" 0, "mergelimit" 10 }, { "statecode" "ka", "articlecode" "ka1005", "stampdutyvalue" 100, "purposeofstampduty" "test", "count" 2 }, { "statecode" "ka", "articlecode" "ka1005", "stampdutyvalue" 100, "purposeofstampduty" "test", "dynamicstampconsumption" true } ] }, "revenuestamp" \[ { "pageno" 1, "location" "topleft", "customdefacement" "this revenue stamp paper, bearing unique reference number {{uniquereferencenumber}}, forms an integral part of the {{documentname}} ", "documentname" "dpn" }, { "pageno" 2, "location" "customize", "xcoordinate" "100", "ycoordinate" "50" } ], "emailpdfcustomnameformat" "signername", "logourl" "", "signonstamp" true, "showaadhaarnameonsignature"\ true, "remindersperday" , "locationcapturemethod" , "clickwrapconsenttext" \[""], "clickwrapconfigurabletext" "digital consent record" "reviewerdetail" \[ { "name" "vamshi", "email" "vamshirp05\@gmail com" } ] }' production curl location 'https //api signzy app/api/v3/contract/initiate' \\ \ header 'authorization ' \\ \ header 'content type application/json' \\ \ header 'x uniquereferenceid ' \\ \ data '{ "pdf" " ", "templatedetails" { "templateid" " ", "jsondata" { "day" "sample text data", "month" "sample text data", "distributorbusinessname" "sample text data", "distributorbusinessaddress" "sample text data", "distributorname" "sample text data" } }, "persistauthkey" " ", "smtpcredentials" { "smtpfromname" " ", "smtpurl" " ", "smtpport" " ", "smtpusername" " ", "smtppassword" " " }, "customsendinglogic" { "url" " ", "event" \[ "otp verification", "contract initiation", "signer confirmation", "final confirmation", "reminder", "reviewer mail" ], "header" "" }, "contractname" "savings account opening form", "contractexecutername" "signzy", "successredirecturl" "https //signzy com", "failureredirecturl" "https //google com", "contractttl" 10000, "callbackurl" "", "callbackurlauthorizationheader" "", "signercallbackurl" "", "signercallbackurlauthorizationheader" "", "esignprovider" "", "namematchthreshold" "0 50", "allowsignergendermatch" true, "allowsigneryobmatch" true, "allowuidlastfourdigitsmatch" true, "allowpincodematch" true, "crossotpverification" true, "emudhracustomization" { "logourl" "", "headercolour" "", "buttoncolour" "", "maskedaadhaarfield" "", "secondarybuttoncolour" "", "pagebackgroundcolour" "", "pagetextcolour" "", "footerbackgroundcolour" "", "footertextcolour" "", "successtextcolour" "", "errortextcolour" "", "errorbackgroundcolour" "", "linktextcolour" "", "infoiconcolour" "", "textfieldbordercolour" "" }, "signerdetail" \[ { "signername" "mayank", "signermobile" "", "signeremail" "", "signergender" "male", "uidlastfourdigits" "", "signeryearofbirth" "", "pincode" "", "signeruniqueid" "", "signaturetype" "aadhaaresign otp", "cancelbysigner" true, "digitalconsent" { "consentdata" \[ { "text" "i confirm that i have opted for debit card", "required" false }, { "text" "i agree to comply with applicable laws", "required" true } ], "consentheading" "terms & conditions" }, "additionalsignaturetypes" \[ "aadhaaresign fingerprint" ], "preverification" \[ "videoverification" ], "postverification" \[ "otp" ], "signatures" \[ { "pageno" \[ "all" ], "signatureposition" \[ "bottomleft" ] } ] }, { "signername" "ashish", "signermobile" "", "signeremail" "", "signergender" "female", "uidlastfourdigits" "", "signeryearofbirth" "", "pincode" "", "signeruniqueid" "", "signaturetype" "smartesign", "organizationname" "" "preverification" \[ "livenessverification" ], "postverification" \[ "imagecapture" ], "matchimage" \[" "], "matchimagethreshold" "", "additionalsignaturetypes" \[ "aadhaaresign fingerprint" ], "signatures" \[ { "pageno" \[ 11, 2, 5 ], "signatureposition" \[ "topleft", "customize" ], "xcoordinate" \[ 300, 5 ], "ycoordinate" \[ 400, 5 ] }, { "pageno" \[ 1, 2, 5 ], "signatureposition" \[ "topleft", "customize" ], "xcoordinate" \[ 300, 5 ], "ycoordinate" \[ 400, 5 ] } ] } ], "docsigner" \[ { "signatureoptions" "docsignerclass3", "certificateid" "", "signingstep" "start", "location" "bangalore", "reason" "testing", "signatures" \[ { "pageno" \[ "all" ], "signatureposition" \[ "topleft" ] }, { "pageno" \[ 2 ], "signatureposition" \[ "customize" ], "xcoordinate" \[ 100 ], "ycoordinate" \[ 50 ] } ] }, { "signatureoptions" "docsignerclass2", "certificateid" "", "signingstep" "start", "location" "bangalore", "reason" "testing", "signatures" \[ { "pageno" \[ "all" ], "signatureposition" \[ "topright" ], "height" 70, "width" 130 }, { "pageno" \[ 2 ], "signatureposition" \[ "customize" ], "xcoordinate" \[ 300 ], "ycoordinate" \[ 50 ] } ] }, { "signatureoptions" "seal", "certificateid" " ", "signingstep" "end", "signatures" \[ { "pageno" \[ 5 ], "signatureposition" \[ "bottomleft", "bottomcenter" ], "height" 100, "width" 50 } ] }, { "signatureoptions" "virtualesign", "certificateid" " ", "signingstep" "start", "signatures" \[ { "pageno" \[ 2 ], "signatureposition" \[ "middleleft", "middlecenter" ] } ] } ], "workflow" true, "isparallel" false, "redirecttime" 5, "locationcapturemethod" "ip", "initiationemailsubject" "please sign the document received on your email", "customermaillist" \[ "" ], "customermaillistvisibility" "cc/bcc" "adminmaillist" \["admin1\@test com", "admin1\@test com"], "estamp" { "type" "", "statecode" "", "articlecode" "", "firstpartyname" "", "secondpartyname" "", "stampdutypaidby" "", "purposeofstampduty" "", "stampdutyvalue" "", "considerationprice" "", "amount" "", "pageno" "", "location" "", "custmondefacement" "", "message" "" }, "estamp" { "stampdetails" \[ { "statecode" "ka", "articlecode" "ka1008", "stampdutyvalue" 600, "purposeofstampduty" "test", "count" "2" } ], "type" "estamp", "firstpartyname" "signzy technolgy", "secondpartyname" "cognizant", "stampdutypaidby" "cognizant", "considerationprice" "" }, "revenuestamp" \[ { "pageno" 1, "location" "topleft", "customdefacement" "this revenue stamp paper, bearing unique reference number {{uniquereferencenumber}}, forms an integral part of the {{documentname}} ", "documentname" "dpn" }, { "pageno" 2, "location" "customize", "xcoordinate" "100", "ycoordinate" "50" } ], "emailpdfcustomnameformat" "signername", "logourl" "", "remindersperday" , "signonstamp" true, "showaadhaarnameonsignature"\ true, "locationcapturemethod" , "clickwrapconsenttext" \[""], "clickwrapconfigurabletext" "digital consent record" "reviewerdetail" \[ { "name" "vamshi", "email" "vamshirp05\@gmail com" } ] }' input parameters header parameters true false 163left unhandled content type false unhandled content type false unhandled content type left unhandled content type left false unhandled content type false unhandled content type false unhandled content type left false unhandled content type body parameters 134,99,112 false true left unhandled content type false unhandled content type false unhandled content type left unhandled content type left false unhandled content type false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type true unhandled content type left true unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left true unhandled content type left true unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type emudhra customizations true falsefalse unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type note all the properties under "emudhracustomization" are marked as optional, as they may not be necessary for the customization, and their absence would not cause any issues docsigner true false 152,106,113false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type estamping details false true 177left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left true unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type revenue stamping details true false 175false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type reviewer details true falseleft false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type left false unhandled content type you can add reviewers who can review the document it can have 3 reviewers and all of them would be in sequential manner sample response 200 { "emudhracustomization" { "buttoncolour" "#ff0000", "headercolour" "#ff0000", "logourl" "https //media trustradius com/vendor logos/th/nh/mvdwep9m89x5 180x180 jpeg" }, "customerid" "bc3024f6 b2de 493f 8b30 e132c3701ce7", "username" "adityasahu", "contractid" "e6b9bf89 5725 4331 9efd 0ff53b914764", "pdf" "https //staging persist signzy tech/api/files/4879875/download/11d297ab903e442784c6a847a2ce10f3970b314ed512437db9f6bdfc55f6b501 pdf", "initialcontracthash" "51acd08565171da3a2e1f50b600df06b444ff18204e53103d2ef590688a3a39a", "contractname" "dd", "contractexecutername" "dd", "successredirecturl" "https //signzy com", "failureredirecturl" "https //google com", "esignprovider" "emudhra", "contractttl" 10000, "signerdetail" \[ { "signerid" "3bd160a3 5e52 4ea8 9819 c1fc1e1bd838", "signername" "mohit", "signaturetype" "aadhaaresign otp", "uidlastfourdigits" "1345", "signeryearofbirth" "0101", "signeruniqueid" "" "signergender" "male", "signatures" \[ { "pageno" \[ "all" ], "signatureposition" \[ "bottomleft" ], "xcoordinate" \[], "ycoordinate" \[] } ], "esignurl" "https //api preproduction signzy app/api/v3/contract/esign/3bd160a3 5e52 4ea8 9819 c1fc1e1bd838" }, { "signerid" "523af19d 762f 40e1 ae00 dbc46f7ed8b1", "signername" "cdcdc", "signaturetype" "aadhaaresign otp", "uidlastfourdigits" "1345", "signeryearofbirth" "0101", "signatures" \[ { "pageno" \[ 11, 2, 5 ], "signatureposition" \[ "topleft", "customize" ], "xcoordinate" \[ 300, 5 ], "ycoordinate" \[ 400, 5 ] }, { "pageno" \[ 1, 2, 5 ], "signatureposition" \[ "topleft", "customize" ], "xcoordinate" \[ 300, 5 ], "ycoordinate" \[ 400, 5 ] } ], "esignurl" "https //api preproduction signzy app/api/v3/contract/esign/523af19d 762f 40e1 ae00 dbc46f7ed8b1" } ], "callbackurl" "https //qa signzy xyz/callback/mohitposts", "callbackurlauthorizationheader" "test", "signercallbackurl" "https //qa signzy xyz/callback/mohitposts", "callbackextraparameter" \[], "filettl" "2 days", "estamp" { "type" "echallan", "secondpartyname" "test", "firstpartyname" "vmware", "statecode" "nl", "articlecode" "nl001", "purposeofstampduty" "sjs", "amount" 1, "location" "middlecenter", "custmondefacement" "true", "message" "stamp duty of rs 1 paid via stamp paper certificate no xdxdxcd dated 121212" }, "estamp" { "type" "estamp", "firstpartyname" "vamshi", "customdefacement" "{{certificateno}}, {{certificatedate}}, {{uniquedocref}}, {{firstpartyname}}, {{statecode}}, {{articlecode}}, {{denomination}}, {{secondpartyname}}, {{stampdutypaidby}}, {{purposeofstampduty}}", "secondpartyname" "vamshi", "stampdutypaidby" "vamshi", "stampdetails" \[ { "statecode" "ap", "articlecode" "ap10001", "stampdutyvalue" 19, "losscap" 2, "mergelimit" 2, "purposeofstampduty" "test", "dynamicstampconsumption" true } ], "transactionid" \[ "670cbb877b191de02a424067", "670cbb877b191de02a424069" ], "estampstatus" "inprogress", "transactionresult" { "certificateinfo" \[ { "certificateno" "562", "uniquedocref" "stamp 1901562" }, { "certificateno" "563", "uniquedocref" "stamp 1901563" } ], "type" "estamp" }, "dynamicstampdetails" \[ { "actualloss" 1, "stampcount" 2, "statecode" "ap", "articlecode" "ap10001", "dynamicstampconsumption" true, "stampbreakdown" \[ { "stampdutyvalue" "10", "count" 2 } ] } ] }, "x uniquereferenceid" "" } output parameters true false 147false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type signerdetail true falsefalse unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type signature (within signerdetail) true falsefalse unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type estamp true falsefalse unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type sample errors 400 { "name" "error", "message" "invalid url extension", "reason" "validation error", "type" "bad request", "statuscode" 400 } 400 { "name" "error", "message" "successredirecturl is not allowed to be empty", "reason" "validation error", "type" "bad request", "statuscode" 400 } 400 { "name" "error", "message" "failureredirecturl is not allowed to be empty", "reason" "validation error", "type" "bad request", "statuscode" 400 } 400 { "name" "error", "message" "esignprovider must be one of \[nsdl, emudhra]", "reason" "validation error", "type" "bad request", "statuscode" 400 } 401 { "message" "invalid authentication credentials" } 500 { "error" { "name" "error", "message" "internal server error", "reason" "internal server error", "type" "internal server error", "statuscode" 500 } } error parameters true falsefalse unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type error codes true falsefalse unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type callback & signer callback response callback response success { "contractid" " ", "contractcreationtime" "29/02/2024, 11 46 20", "initialsignercount" 1, "signedsignercount" 1, "deletedsignercount" 0, "contractname" "signzy", "contractexecutername" "manish", "successredirecturl" "https //signzy com", "failureredirecturl" "https //google com", "callbackurl" " ", "signercallbackurl" " ", "contractttl" 16800, "initialcontract" " ", "initialcontracthash" " ", "finalsignedcontract" " ", "finalsignedcontracthash" " ", "auditcertificateurl" " ", "auditcertificatehash" " ", "iscompleted" true, "contractcompletiontime" "thu feb 29 2024 11 49 16 gmt+0530 (india standard time)", "docsigner" \[ { "input" { "certificateid" " ", "signatureoptions" "docsignerclass2", "signingstep" "start", "logourl" " ", "signatures" \[ { "pageno" \[ 2, 3 ], "signatureposition" \[ "topleft", "topcenter" ] } ] }, "status" "success", "docsigncompletiontime" "thu feb 29 2024 11 46 22 gmt+0530 (india standard time)", "docsignedcontract" " ", "docsignedcontracthash" " " }, { "input" { "signatureoptions" "docsignerclass3", "signingstep" "end", "docsignerclass3certificatevalues" { "clientid" " 8", "keyid" " ", "accesskey" " " }, "location" "bangalore", "reason" "testing", "signatures" \[ { "pageno" \[ 3, 2 ], "signatureposition" \[ "bottomright", "bottomcenter" ] } ] }, "status" "success", "docsigncompletiontime" "thu feb 29 2024 11 49 14 gmt+0530 (india standard time)", "docsignedcontract" " ", "docsignedcontracthash" " " } ], "signerdetail" \[ { "signername" "d vamshi krishna", "signeremail" " ", "signermobile" " ", "signergender" "female", "signeryearofbirth" " ", "workflowurl" " ", "signerid" " ", "signaturetype" " ", "additionalsignaturetypes" \[ "aadhaaresign fingerprint" ], "contractlastsigntime" "2024 02 29t11 48 59", "contractsendtime" "thu feb 29 2024 11 46 23 gmt+0530 (india standard time)", "status" "success", "selectedsignaturetype" "aadhaaresign otp", "errormessage" "na", "aadhaarstatus" "1", "aadhaarerrormessage" "", "namematchresult" "", "signerip" " ", "noofsuccessfulattempts" 1, "signersignedcontract" " ", "signersignedcontracthash" " ", "esignattempts" \[ { "sessionid" "de01ddd8 54c5 4a32 9bcf ef5fc9a53b23", "workflowurlopentime" "thu feb 29 2024 11 46 39 gmt+0530 (india standard time)", "signatureselecttime" "thu feb 29 2024 11 47 28 gmt+0530 (india standard time)", "espinvokerequesttime" "thu feb 29 2024 11 47 31 gmt+0530 (india standard time)", "transaction" { "transactiondata" { "esignprovider" "emudhra", "dscdata" { "state" " ", "pincode" " ", "dnqualifier" " ", "yob" " ", "gender" "male", "uidlastfourdigits" " ", "x500uniqueidentifier" "", "aadhaartoken" "", "pseudonym" " ", "aadhaartype" "personal", "country" "in", "name" " " }, "selectedsignaturetype" "aadhaaresign otp" } }, "signingcompletetime" "thu feb 29 2024 11 49 08 gmt+0530 (india standard time)" } ] } ], "deletedsignerdetail" \[] } signer callback response success { "signername" " ", "signeremail" " ", "signermobile" " ", "signergender" " ", "signeryearofbirth" " ", "workflowurl" " ", "signerid" "6696c60e 1102 47f1 93db d3cb2899233c", "signaturetype" "aadhaaresign otp", "additionalsignaturetypes" \[ "aadhaaresign fingerprint" ], "contractlastsigntime" "2024 02 29t11 48 59", "contractsendtime" "thu feb 29 2024 11 46 23 gmt+0530 (india standard time)", "status" "success", "selectedsignaturetype" "aadhaaresign otp", "errormessage" "na", "aadhaarstatus" "1", "aadhaarerrormessage" "", "namematchresult" "", "signerip" " ", "noofsuccessfulattempts" 1, "signersignedcontract" " ", "signersignedcontracthash" " ", "esignattempts" \[ { "sessionid" "de01ddd8 54c5 4a32 9bcf ef5fc9a53b23", "workflowurlopentime" "thu feb 29 2024 11 46 39 gmt+0530 (india standard time)", "signatureselecttime" "thu feb 29 2024 11 47 28 gmt+0530 (india standard time)", "espinvokerequesttime" "thu feb 29 2024 11 47 31 gmt+0530 (india standard time)", "transaction" { "transactiondata" { "esignprovider" "emudhra", "dscdata" { "state" " ", "pincode" " ", "dnqualifier" " ", "yob" " ", "gender" "male", "uidlastfourdigits" " ", "x500uniqueidentifier" "", "aadhaartoken" "", "pseudonym" " ", "aadhaartype" "personal", "country" "in", "name" " " }, "selectedsignaturetype" "aadhaaresign otp" } }, "signingcompletetime" "thu feb 29 2024 11 49 08 gmt+0530 (india standard time)" } ], "contractid" "c7c584aa 998c 4e48 9701 8cae40573b4a" } uid last 4 digits mismatch { "signername" " ", "signeremail" " ", "signermobile" " ", "signergender" " ", "signeryearofbirth" " ", "workflowurl" " ", "signerid" " ", "signaturetype" "aadhaaresign otp", "additionalsignaturetypes" \[ "aadhaaresign fingerprint" ], "contractlastsigntime" "2024 02 29t11 56 03", "contractsendtime" "thu feb 29 2024 11 52 56 gmt+0530 (india standard time)", "status" "fail", "selectedsignaturetype" "aadhaaresign otp", "errormessage" "uid last four digits match validation failed", "aadhaarstatus" "1", "aadhaarerrormessage" "", "namematchresult" "", "signerip" "", "noofsuccessfulattempts" 1, "signersignedcontract" "", "signersignedcontracthash" "", "esignattempts" \[ { "sessionid" "6416c55d e58b 4448 8a1c 7402d2c29136", "workflowurlopentime" "thu feb 29 2024 11 53 18 gmt+0530 (india standard time)", "signatureselecttime" "thu feb 29 2024 11 55 03 gmt+0530 (india standard time)", "espinvokerequesttime" "thu feb 29 2024 11 55 06 gmt+0530 (india standard time)", "transaction" { "transactiondata" { "esignprovider" "emudhra", "dscdata" { "state" " ", "pincode" " ", "dnqualifier" " ", "yob" " ", "gender" "male", "uidlastfourdigits" " ", "x500uniqueidentifier" "", "aadhaartoken" "", "pseudonym" " ", "aadhaartype" "personal", "country" "in", "name" " " }, "selectedsignaturetype" "aadhaaresign otp" } }, "errorcode" "", "errormessage" "uid last four digits match validation failed", "signingfailtime" "thu feb 29 2024 11 56 04 gmt+0530 (india standard time)" } ], "contractid" "c7c584aa 998c 4538 9206 8cae40573b4a" } yob mismatch { "signername" "", "signeremail" "", "signermobile" "", "signergender" "", "signeryearofbirth" "", "workflowurl" "", "signerid" "", "signaturetype" "aadhaaresign otp", "additionalsignaturetypes" \[ "aadhaaresign fingerprint" ], "contractlastsigntime" "2024 02 29t11 30 50", "contractsendtime" "thu feb 29 2024 11 29 34 gmt+0530 (india standard time)", "status" "fail", "selectedsignaturetype" "aadhaaresign otp" "errormessage" "yob match validation failed", "aadhaarstatus" "1", "aadhaarerrormessage" "", "namematchresult" "", "signerip" "", "noofsuccessfulattempts" 1, "signersignedcontract" "", "signersignedcontracthash" "", "esignattempts" \[ { "sessionid" "e36a1297 3b73 46c2 a0c4 30cd7ac57b5b", "workflowurlopentime" "thu feb 29 2024 11 29 49 gmt+0530 (india standard time)", "signatureselecttime" "thu feb 29 2024 11 29 54 gmt+0530 (india standard time)", "espinvokerequesttime" "thu feb 29 2024 11 29 55 gmt+0530 (india standard time)", "transaction" { "transactiondata" { "esignprovider" "emudhra", "dscdata" { "state" "", "pincode" "", "dnqualifier" "", "yob" "", "gender" "", "uidlastfourdigits" "", "x500uniqueidentifier" "", "aadhaartoken" "", "pseudonym" "", "aadhaartype" "", "country" "in", "name" "" }, "selectedsignaturetype" "aadhaaresign otp" } }, "errorcode" "", "errormessage" "yob match validation failed", "signingfailtime" "thu feb 29 2024 11 30 50 gmt+0530 (india standard time)" } ], "contractid" "c7c584aa 998c 4e38 9201 8cve405o3b4a" } name mismatch { "signername" "", "signeremail" "", "signermobile" "", "signergender" "", "signeryearofbirth" "", "workflowurl" "", "signerid" "", "signaturetype" "aadhaaresign otp", "additionalsignaturetypes" \[ "aadhaaresign fingerprint" ], "contractlastsigntime" "2024 02 29t12 34 44", "contractsendtime" "thu feb 29 2024 12 29 29 gmt+0530 (india standard time)", "status" "fail", "selectedsignaturetype" "aadhaaresign otp" "errormessage" "name match validation failed", "aadhaarstatus" "1", "aadhaarerrormessage" "", "namematchresult" "0 85", "signerip" "", "noofsuccessfulattempts" 1, "signersignedcontract" "", "signersignedcontracthash" "", "esignattempts" \[ { "sessionid" "8563cd61 cb21 4738 a70b c31b814df19f", "workflowurlopentime" "thu feb 29 2024 12 29 38 gmt+0530 (india standard time)", "signatureselecttime" "thu feb 29 2024 12 29 40 gmt+0530 (india standard time)", "espinvokerequesttime" "thu feb 29 2024 12 29 41 gmt+0530 (india standard time)", "transaction" {}, "errorcode" "esp 945", "errormessage" "user terminated ekyc process after otp generation", "signingfailtime" "thu feb 29 2024 12 30 21 gmt+0530 (india standard time)" }, { "sessionid" "51b71cca 54e0 4a40 a981 9011d02424e5", "workflowurlopentime" "thu feb 29 2024 12 31 26 gmt+0530 (india standard time)", "signatureselecttime" "thu feb 29 2024 12 31 27 gmt+0530 (india standard time)", "espinvokerequesttime" "thu feb 29 2024 12 31 29 gmt+0530 (india standard time)", "transaction" {}, "errorcode" "esp 944", "errormessage" "user terminated ekyc process", "signingfailtime" "thu feb 29 2024 12 31 37 gmt+0530 (india standard time)" }, { "sessionid" "9a5175a0 88b0 4a66 8e06 8e815dc4095e", "workflowurlopentime" "thu feb 29 2024 12 33 46 gmt+0530 (india standard time)", "signatureselecttime" "thu feb 29 2024 12 33 52 gmt+0530 (india standard time)", "espinvokerequesttime" "thu feb 29 2024 12 33 53 gmt+0530 (india standard time)", "transaction" { "transactiondata" { "esignprovider" "emudhra" "dscdata" { "state" "", "pincode" "", "dnqualifier" "", "yob" "", "gender" "male", "uidlastfourdigits" "", "x500uniqueidentifier" "", "aadhaartoken" "", "pseudonym" "", "aadhaartype" "personal", "country" "in", "name" "" }, "selectedsignaturetype" "aadhaaresign otp" } }, "errorcode" "", "errormessage" "name match validation failed", "signingfailtime" "thu feb 29 2024 12 34 44 gmt+0530 (india standard time)" } ], "contractid" "c7c582aa 998c 4e38 9201 8c9e40573b4a" } maximum otp limits { "signername" "", "signeremail" "", "signermobile" "", "signergender" "", "signeryearofbirth" "", "workflowurl" "", "signerid" "", "signaturetype" "aadhaaresign otp", "additionalsignaturetypes" \[ "aadhaaresign fingerprint" ], "contractlastsigntime" "2024 02 29t12 28 10", "contractsendtime" "thu feb 29 2024 12 27 13 gmt+0530 (india standard time)", "status" "fail", "selectedsignaturetype" "aadhaaresign otp" "errormessage" "user has crossed maximum authentication attempt", "aadhaarstatus" "0", "aadhaarerrormessage" "user has crossed maximum authentication attempt", "namematchresult" "", "signerip" "", "noofsuccessfulattempts" 0, "signersignedcontract" "", "signersignedcontracthash" "", "esignattempts" \[ { "sessionid" "5441c860 4f16 4f45 94d6 fbfbba8de36a", "workflowurlopentime" "thu feb 29 2024 12 27 27 gmt+0530 (india standard time)", "signatureselecttime" "thu feb 29 2024 12 27 29 gmt+0530 (india standard time)", "espinvokerequesttime" "thu feb 29 2024 12 27 31 gmt+0530 (india standard time)", "transaction" {}, "errorcode" "esp 946", "errormessage" "user has crossed maximum authentication attempt", "signingfailtime" "thu feb 29 2024 12 28 15 gmt+0530 (india standard time)" } ], "contractid" "c7c58eaa 998c 4e38 0201 8coe40573b4a" } user defined fields the purpose of user defined fields is to offer you the capability to transmit any of the customer's data for mapping within our system steps to use user defined fields you can define an object with the following structure { "userdefinedfield" { "homeloankey" "boolean", "homeloankey2" "string", "homeloankey3" "number", "homeloankey4" "string", "homeloankey5" "number" } } the keys of the object userdefinedfield has to be defined by the client and it will be part of settings for example, in above case, "homeloankey" has been defined and the type of key is set to be boolean the type of key can be either boolean, string or number once it is defined, it can be part of initiate contract api payload all of these fields will be optional at maximum, you can define 20 keys