Setting Up

Upload Doc Signer Class 3 Certificate

9min

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 configure your Document Signer Certificate Class 3 by simply inputting ClientID, KeyId and Accesskey of the certificate. Once added, 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
Production
curl --location 'https://api.signzy.app/api/v3/esign/uploadDocSignConfig' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXX' \
--form 'type="DocSignerClass3"' \
--form 'certificateName="test certificate"' \
--form 'clientId="XXX"' \
--form 'keyId="XXX"' \
--form 'accessKey="XXXXXX"'
curl --location 'https://api.signzy.app/api/v3/esign/uploadDocSignConfig' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXX' \
--form 'type="DocSignerClass3"' \
--form 'certificateName="test certificate"' \
--form 'clientId="XXX"' \
--form 'keyId="XXX"' \
--form 'accessKey="XXXXXX"'
﻿
Input Parameters
Parameter Name
Type
Mandatory/Optional
Description
type
String
Mandatory
For uploading DSC class 3 certificate, pass 'DocSignerClass3'
certificateName
String
Mandatory
Title for the certificate uploaded
clientId
String
Mandatory
Client ID of the Document Signer Class 3 Certificate
keyId
String
Mandatory
KeyId of the Document Signer Class 3 Certificate
accessKey
String
Mandatory
Access key of the Document Signer Class 3 Certificate
Sample Response
200
{
    "certificateId": "66547c971ddbd3b75a893f7c",
    "isUploadSuccessful": true,
    "certificateName": "test certificate"
}
{
    "certificateId": "66547c971ddbd3b75a893f7c",
    "isUploadSuccessful": true,
    "certificateName": "test certificate"
}
﻿
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﻿
If the upload is unsucessful, the value would be FALSE﻿
certificateName
String
Title of the certificate 
Sample Errors
400
400
401
404
500
504
{
    "name": "error",
    "message": "docSignerClass2PfxFile is not allowed to be empty",
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": 400
}
{
    "name": "error",
    "message": "docSignerClass2PfxFile is not allowed to be empty",
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": 400
}
﻿
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 [email protected]
﻿

Parameter Name	Type	Mandatory/Optional	Description
type	String	Mandatory	For uploading DSC class 3 certificate, pass 'DocSignerClass3'
certificateName	String	Mandatory	Title for the certificate uploaded
clientId	String	Mandatory	Client ID of the Document Signer Class 3 Certificate
keyId	String	Mandatory	KeyId of the Document Signer Class 3 Certificate
accessKey	String	Mandatory	Access key of the Document Signer Class 3 Certificate

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 If the upload is unsucessful, the value would be FALSE
certificateName	String	Title of the certificate

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
500	Internal Server Error	Internal error at Signzy, Please write to us at [email protected]

Updated 30 May 2024

Did this page help you?

Overview Of Document Signer Certificate

Upload Doc Signer Class 2 Certificate