Send Reminders

The Yoti Sign API has an ‘send-reminder’ function. This allows you to send recipients a reminder to sign an envelope.

Sandbox:

POST https://demo.api.yotisign.com/v2/envelopes/{envelope_id}/recipients/{recipient_id}/send-reminder

Production:

POST https://api.yotisign.com/v2/envelopes/{envelope_id}/recipients/{recipient_id}/send-reminder

Headers explained

The following elements are needed:

Headers	Content
Authorization	API Key to call the Yoti Sign API. This should be sent as a bearer token.
Content-Type	application/json

Example code

const rp = require("request-promise");

const searchEnvelope = () => {

const request = {

method: "POST",

uri: "<BASE_URL>/v2/envelopes/{envelope_id}/recipients/{recipient_id}/send-reminder",

headers: {

authorization: "Bearer <API_KEY>",

};

return rp(request)

.then((body) => body)

.catch((err) => err);

};

//send request

let result = await searchEnvelope();

package com.yoti.sign;

import java.io.IOException;

import java.net.URI;

import javax.json.Json;

import javax.json.JsonObject;

import javax.json.JsonReader;

import org.apache.http.HttpResponse;

import org.apache.http.client.methods.HttpGet;

import org.apache.http.impl.client.CloseableHttpClient;

import org.apache.http.impl.client.HttpClients;

public class MainSearchEnvelope {

private static final String YOTI_SIGN_AUTH_TOKEN = "<YOUR_AUTH_TOKEN>";

private static final String YOTI_SIGN_BASE_URL = "https://api.yotisign.com/v2";

public static void main(String[] args) {

CloseableHttpClient client = HttpClients.createDefault();

HttpPost httpPost = new HttpGet();

httpPost.setHeader("Authorization", "Bearer " + YOTI_SIGN_AUTH_TOKEN);

<?php

use GuzzleHttp\Client;

use GuzzleHttp\Psr7\Request;

$request = new Request(

'POST',

API_BASE_URL . "/envelopes/{envelope_id}/recipients/{recipient_id}/send-reminder",

[

'headers' => [

'Authorization' => 'Bearer ' . YOUR_API_KEY,

'Content-Type' => 'application/json',

]

);

$client = new Client();

$response = $client->send($request);

$json = json_decode($response->getBody());

using (HttpRequestMessage request = new HttpRequestMessage

{

Method = new HttpMethod("POST"),

RequestUri = new Uri("https://api.yotisign.com/v2/envelopes/{envelope_id}/recipients/{recipient_id}/send-reminder")

})

{

request.Headers.Add("Authorization", "Bearer " + "<API_KEY>");

using (HttpClient httpClient = new HttpClient())

{

HttpResponseMessage response = httpClient.SendAsync(request).Result;

string responseContent = response.Content.ReadAsStringAsync().Result;

return new JsonResult(

responseContent,

new JsonSerializerOptions

{

WriteIndented = true,

Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping

req, err := http.NewRequest("POST", "<BASE_URL>/v2/envelopes/{envelope_id}/recipients/{recipient_id}/send-reminder", nil)

req.Header.Add("Authorization", "Bearer <API_KEY>")

client := &http.Client{}

response, err := client.Do(req)

if err != nil {

fmt.Println(err)

} else {

result, _ := ioutil.ReadAll(response.Body)

}

Example Response

{

"recipient_id": {{ recipient_id }}

}

Error codes

If the request is unsuccessful a response code and a message will be sent

Last updated on

Was this page helpful?