Delete Signer API

9min

Introduction
Introducing the Delete Signer API – your solution for seamless signer management within your contract workflows. With just a contract ID and signer ID input, efficiently remove a signer from the contract, revoking their access to the signing link. This powerful tool grants you the ability to fine-tune your contract process by eliminating a signer if needed, allowing the contract to progress and complete seamlessly with remaining signers. Experience enhanced control over your contract lifecycle with the Delete Signer API – optimizing signer dynamics and ensuring a smooth and secure contract execution 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/contract/deleteSigner' \
--header 'Authorization: ****************************' \
--header 'Content-Type: application/json' \
--data '{
    "contractId": "**********************************",
    "signerId": "**********************************"
}'
curl --location 'https://api.signzy.app/api/v3/contract/deleteSigner' \
--header 'Authorization: ****************************' \
--header 'Content-Type: application/json' \
--data '{
    "contractId": "**********************************",
    "signerId": "**********************************"
}'
﻿
Input Parameters
Key
Description
Type
Mandatory/Optional
contractId
ID of the contract
String
Mandatory
signerId
ID of the signer to be deleted
String
Mandatory
Sample Response
200
{
    "contractId": "7cc1c966-aa57-49e4-8968-2343b2785baf",
    "signerId": "bcda03a8-b38e-4e1f-9ba0-17b2acaa6908",
    "message": "Signer deleted successfully"
}
{
    "contractId": "7cc1c966-aa57-49e4-8968-2343b2785baf",
    "signerId": "bcda03a8-b38e-4e1f-9ba0-17b2acaa6908",
    "message": "Signer deleted successfully"
}
﻿
Output Parameters
Field Name
Description
Type
contractId
Unique identifier for the contract.
String
signerId
Unique identifier for the deleted signer.
String
message
Confirmation message for signer deletion.
String
Sample Errors
400
400
400
400
401
404
404
500
{
    "name": "error",
    "message": "contractId length must be 36 characters long",
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": 400
}
{
    "name": "error",
    "message": "contractId length must be 36 characters long",
    "reason": "VALIDATION_ERROR",
    "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 or the Contract 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
contractId	ID of the contract	String	Mandatory
signerId	ID of the signer to be deleted	String	Mandatory

Field Name	Description	Type
contractId	Unique identifier for the contract.	String
signerId	Unique identifier for the deleted signer.	String
message	Confirmation message for signer deletion.	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 or the Contract ID is not found in the system
500	Internal Server Error	Internal error at Signzy, Please reach out to [email protected]

Updated 30 Aug 2024

Did this page help you?

Pull Contract API

Remind Signer API