Remind Signer API

10min

Introduction
In today's fast-paced digital landscape, efficient communication and streamlined processes are vital for businesses to thrive. The Remind Signer API emerges as a powerful tool designed to enhance the contract signing experience by facilitating timely reminders to signers. With the ability to seamlessly integrate into existing systems, this API offers a straightforward solution for organizations seeking to optimize their contract management workflows.
The Remind Signer API operates on a simple premise: to prompt signers to execute contracts promptly and conveniently. By leveraging unique identifiers such as signer IDs, this API initiates personalized reminders through various channels including email, SMS, and WhatsApp. Through targeted communication, signers are gently nudged towards fulfilling their signing obligations, thereby expediting the overall contract execution process.
This introduction serves as a gateway to understanding the capabilities and functionalities of the Remind Signer API. In the subsequent sections, we delve deeper into its features, implementation strategies, and the transformative impact it can have on modern business operations. Join us as we explore how the Remind Signer API revolutionizes contract management and fosters enhanced efficiency and reliability in the digital era.
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/remindSigner' \
--header 'Authorization: ****************************' \
--header 'Content-Type: application/json' \
--data '{
    "signerId" : "**********************"
}'
curl --location 'https://api.signzy.app/api/v3/contract/remindSigner' \
--header 'Authorization: ****************************' \
--header 'Content-Type: application/json' \
--data '{
    "signerId" : "**********************"
}'
﻿
Input Parameters
Key
Description
Type
Mandatory/Optional
signerId
ID of the signer for which the signature type needs to be changed
String
Mandatory
Sample Response
200
{
    "isSuccess": true
}
{
    "isSuccess": true
}
﻿
Output Parameters
Field Name
Description
Type
isSuccess
The status for the updation of the remind signer API
String
Sample Errors
400
400
400
400
401
404
500
{
    "error": {
        "name": "error",
        "message": "Internal Server Error",
        "reason": "INTERNAL_SERVER_ERROR",
        "type": "Internal Server Error",
        "statusCode": 500
    }
}
{
    "error": {
        "name": "error",
        "message": "Internal Server Error",
        "reason": "INTERNAL_SERVER_ERROR",
        "type": "Internal Server Error",
        "statusCode": 500
    }
}
﻿
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

Field Name	Description	Type
isSuccess	The status for the updation of the remind signer API	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 30 Aug 2024

Did this page help you?

Delete Signer API

Complete Contract API