Change Signature Type API

9min

Introduction
Introducing our groundbreaking Change Signature Type API, a powerful tool designed to revolutionize the way you manage digital signatures. This API empowers developers and businesses by providing a seamless solution to modify signature types associated with a specific signer ID. With just a simple input of the signer ID and the desired signature type, our Change Signature Type API facilitates effortless customization of signatures, offering flexibility and efficiency in contract authentication processes. Whether you need to adapt to evolving regulatory requirements or cater to individual preferences, our API ensures a smooth transition, allowing you to tailor the signature experience to meet your unique needs. Unlock the potential for dynamic and adaptive signature management with our Change Signature Type API, streamlining your contract workflow like never before.
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-preproduction.signzy.app/api/v3/esign/signer/changeSignatureType' \
--header 'Authorization: ****************************' \
--header 'Content-Type: application/json' \
--data '{
    "signerId": "********************************",
    "signatureType": "AADHAARESIGN-FACEAUTH"
}'
curl --location 'https://api-preproduction.signzy.app/api/v3/esign/signer/changeSignatureType' \
--header 'Authorization: ****************************' \
--header 'Content-Type: application/json' \
--data '{
    "signerId": "********************************",
    "signatureType": "AADHAARESIGN-FACEAUTH"
}'
﻿
Input Parameters
Key
Description
Type
Mandatory/Optional
signerId
ID of the signer for which the signature type needs to be changed
String
Mandatory
signatureType
The type of signatures. The three possible values are -
aadhaaresign-otp, 
aadhaaresign-fingerprint
aadhaaresign-faceauth
String
Mandatory
Sample Response
200
{
    "isSuccess": true
}
{
    "isSuccess": true
}
﻿
Output Parameters
Field Name
Description
Type
isSuccess
The status for the updation of the type of signature
String
Sample Errors
400
400
400
400
400
401
404
500
{
  "name": "error",
  "message": "Signer already signed. Cannot change signatureType",
  "reason": "Bad Request",
  "type": "Bad Request",
  "statusCode": 400
}
{
  "name": "error",
  "message": "Signer already signed. Cannot change signatureType",
  "reason": "Bad Request",
  "type": "Bad Request",
  "statusCode": 400
}
﻿
Error Parameters
Parameter
Type
Description
name
String
In case of errors, it will have the value "error". It represents an error.
message
String
Message for the error
reason
String
Reasons 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
Signer ID is not found in the system
500
Internal Server Error
Internal error at Signzy, Please reach out to [email protected]
﻿

Key	Description	Type	Mandatory/Optional
signerId	ID of the signer for which the signature type needs to be changed	String	Mandatory
signatureType	The type of signatures. The three possible values are - aadhaaresign-otp, aadhaaresign-fingerprint aadhaaresign-faceauth	String	Mandatory

Field Name	Description	Type
isSuccess	The status for the updation of the type of signature	String

Parameter	Type	Description
name	String	In case of errors, it will have the value "error". It represents an error.
message	String	Message for the error
reason	String	Reasons 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	Signer ID is not found in the system
500	Internal Server Error	Internal error at Signzy, Please reach out to [email protected]

Updated 28 Feb 2024

Did this page help you?

Delete Signer API

FAQs