Setting Up

Delete DocSignConfig API

9min

Introduction
Welcome to the Delete DocSignConfig API documentation! This comprehensive guide will show you an efficient process to remove DSC Class 2, DSC Class 3 certificates, company seals, or authorized signatures uploaded for auto virtual signing from your system using our robust API. Whether you're a developer integrating this feature into your application or an administrator managing digital certificates, this API empowers you to effortlessly delete DSC certificates or uploaded signatures/seals files by their unique Certificate ID. By following the instructions outlined in this documentation, you'll be able to streamline your certificate management workflow and ensure the security and integrity of your digital assets. Let's dive in and explore how to leverage the Delete DocSignConfig API to efficiently manage your certificates.
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
Production
curl --location --request DELETE 'https://api-preproduction.signzy.app/api/v3/esign/deleteDocSignConfig' \
--header 'Content-Type: application/json' \
--header 'Authorization: ****************************' \
--data '{
    "certificateId": ""
}'
curl --location --request DELETE 'https://api-preproduction.signzy.app/api/v3/esign/deleteDocSignConfig' \
--header 'Content-Type: application/json' \
--header 'Authorization: ****************************' \
--data '{
    "certificateId": ""
}'
﻿
Input Parameters
Parameter Name
Type
Mandatory/Optional
Description
certficateId
String
Mandatory
ID of the certificate that was uploaded, which needs to be deleted
Sample Response
200
{
    "deleted": true
}
{
    "deleted": true
}
﻿
Output Parameters
Parameter Name
Type
Description
deleted
Boolean
True/False
It tells the status of deletion of certificate from the system.
Sample Errors
400
401
404
500
{
    "message": "Invalid authentication credentials"
}
{
    "message": "Invalid authentication credentials"
}
﻿
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
404
Not found
The certificate ID entered is not stored in the system
500
Internal Server Error
Internal error at Signzy, Please write to us at [email protected]
﻿

Parameter Name	Type	Mandatory/Optional	Description
certficateId	String	Mandatory	ID of the certificate that was uploaded, which needs to be deleted

Parameter Name	Type	Description
deleted	Boolean	True/False It tells the status of deletion of certificate from the system.

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 Code	Error Message	Explanation
400	Bad Request	Input parameter has a missing required parameter or invalid inputs
401	Authorization Failed	Authorization token is invalid
404	Not found	The certificate ID entered is not stored in the system
500	Internal Server Error	Internal error at Signzy, Please write to us at [email protected]

Updated 30 May 2024

Did this page help you?

Upload Seal stamp for Auto signing

Procurement Of Document Signer Certificates