---
title: Remind Signer API
slug: contract360/remind-signer-api
createdAt: 2024-02-28T04:38:26.864Z
---

# 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.&#x20;

# API Details

The details of the API can be found here.

## Sample cURL

:::CodeblockTabs
Pre Production

```curl
curl --location 'https://api-preproduction.signzy.app/api/v3/contract/remindSigner' \
--header 'Authorization: ***************************' \
--header 'Content-Type: application/json' \
--data '{
    "signerId" : "**********************"
}'
```

Production

```curl
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

:::CodeblockTabs
200

```json
{
    "isSuccess": true
}
```
:::

## Output Parameters

| **Field Name** | **Description**                                      | **Type** |
| -------------- | ---------------------------------------------------- | -------- |
| isSuccess      | The status for the updation of the remind signer API | String   |

## Sample Errors

:::CodeblockTabs
400

```json
{
    "name": "error",
    "message": "Reminder can not be send.",
    "reason": "BAD_REQUEST",
    "type": "Not Found",
    "statusCode": 404
}
```

400

```json
{
    "name": "error",
    "message": "signerId is required",
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": 400
}
```

400

```json
{
  "name": "error",
  "message": "Signer already signed. Cannot send reminders",
  "reason": "Bad Request",
  "type": "Bad Request",
  "statusCode": 400
}
```

400

```json
{
  "name": "error",
  "message": "Signer already signed",
  "reason": "Bad Request",
  "type": "Bad Request",
  "statusCode": 400
}
```

401

```json
{
    "message": "Invalid authentication credentials"
}
```

404

```json
{
  "name": "error",
  "message": "Signer Not Found",
  "reason": "Bad Request",
  "type": "Not Found",
  "statusCode": 404
}
```

500

```json
{
    "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 help\@signzy.com     |

