Upload Doc Signer Class 2 Certificate

introduction introducing the " upload doc sign config " – a powerful tool designed to streamline the process of securely incorporating digital signatures into your document workflow this api enables you to effortlessly upload your document signer certificate class 2, represented as a pfx file, along with its corresponding password once uploaded, the api employs robust encryption mechanisms to safeguard this sensitive information within the server this ensures that your certificate remains protected and confidential, ready to be utilized for the seamless and secure signing of documents with this innovative solution, you can confidently enhance your document signing procedures, maintaining the highest standards of security and integrity throughout the process 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/esign/uploaddocsignconfig' \\ \ header 'authorization xxxxxxxxxxxxxxxxxxxx' \\ \ form 'type="docsignerclass2"' \\ \ form 'certificatename="test certificate"' \\ \ form 'docsignerclass2pfxfile=@"/path/to/file"' \\ \ form 'passwordofpfxfile=""' \\ \ form 'docsignerclass2pfxurl=""' \\ \ form 'logourl=""' \\ \ form 'ttl="1 year"' production curl location 'https //api signzy app/api/v3/esign/uploaddocsignconfig' \\ \ header 'authorization xxxxxxxxxxxxxxxxxxxx' \\ \ form 'type="docsignerclass2"' \\ \ form 'certificatename="test certificate"' \\ \ form 'docsignerclass2pfxfile=@"/path/to/file"' \\ \ form 'docsignerclass2pfxurl=""' \\ \ form 'passwordofpfxfile=""' \\ \ form 'logourl=""' \\ \ form 'ttl="1 year"' input parameters parameter name type mandatory/optional description type string mandatory for uploading dsc class 2 certificate, pass 'docsignerclass2' certificatename string optional name for the certificate uploaded this will be used in the signature appearance printed on the document if not passed, origianal name fetched from certificate details will be used in the signature appearance docsignerclass2pfxfile file conditionally mandatory upload the pfx file this will be in the name of organization and will be used for signing of the documents note not required incase docsignerclass2pfxurl is passed docsignerclass2pfxurl string conditionally mandatory pass the url of pfx file this will be used for signing the documents note not required incase docsignerclass2pfxfile is uploaded passwordofpfxfile string mandatory password of the pfx file logourl string optional 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) ttl string mandatory number of days/months/year for which the pfx file uploaded by you will be in signzy's system post that, it will be purged permanently for example, 1 days, 2 days, 10 days, 1 month, 3 month, etc sample response 200 { "certificateid" "66547fb11ddbd3b75a893ff2", "isuploadsuccessful" true, "certificatename" "ds signzy technologies private limited 10", "validfrom" "2024 02 22t12 18 24 000z", "validtill" "2027 02 21t12 18 24 000z", "ttl" "2025 05 27t12 42 25 021z" } output parameters parameter name type description certificateid string id of the certificate that has been uploaded, the certificate id has to be used while doing the esign isuploadsuccessful boolean if the upload is successful, the value would be true true if the upload is unsucessful, the value would be false false certificatename string title of the certificate validfrom string the start date of the validity of the certificate validtill string the end date of the validity of the certificate sample errors 400 { "name" "error", "message" "docsignerclass2pfxfile is not allowed to be empty", "reason" "validation error", "type" "bad request", "statuscode" 400 } 400 { "name" "error", "message" "validation failed for dsc certificate", "reason" "bad request", "type" "bad request", "statuscode" 400 } 401 { "message" "invalid authentication credentials" } 404 { "name" "error", "message" "unable to download file", "reason" "not found error", "type" "not found", "statuscode" 404 } 500 { "message" "internal server error" } 504 { "message" "the upstream server is timing out" } error parameter parameter type description name string in case of error, the name will come as "error" message string error message reason string reason for the error type string type of error statuscode string status code of the error 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 500 internal server error internal error at signzy, please write to us at help\@signzy com