Find envelope

The Yoti Sign API has a ‘find’ function. This allows you to find the envelope details for specified envelopes.

Sandbox:

POST https://demo.api.yotisign.com/v2/organisations/envelopes/find

Production:

POST https://api.yotisign.com/v2/organisations/envelopes/find

Header explained

The following elements are needed:

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

Request body

{

"envelope_ids": [

<id>,

<id>

]

}

Example code

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

const findEnvelope = () => {

const request = {

method: "POST",

uri: "<BASE_URL>/v2/organisations/envelopes/find",

body: JSON.stringify({

"envelope_ids": [

<id>,

<id>

]

}),

headers: {

authorization: "Bearer <API_KEY>",

};

return rp(request)

.then((body) => body)

.catch((err) => err);

};

//send request

let result = await findEnvelope();

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 MainFindEnvelope {

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();

final String envelopeId = "<YOUR_ENVELOPE_ID>";

HttpPost httpPost = new HttpPost();

<?php

use GuzzleHttp\Client;

use GuzzleHttp\Psr7\Request;

$request = new Request(

'POST',

API_BASE_URL . "/organisations/envelopes/find",

[

'headers' => [

'Authorization' => 'Bearer ' . YOUR_API_KEY,

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

'body' => [

"envelope_ids" => [

<id>,

<id>

]

);

$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/organisations/envelopes/find")

})

{

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

// add request body

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

options := `{}`

payload := &bytes.Buffer{}

writer := multipart.NewWriter(payload)

_ = writer.WriteField("options", options)

req, err := http.NewRequest("POST", "<BASE_URL>/organisations/envelopes/find", payload)

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

req.Header.Add("Content-Type", "application/json")

client := &http.Client{}

response, err := client.Do(req)

if err != nil {

fmt.Println(err)

} else {

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

}

Example Response

{

"envelopes": [

{

"envelope_id": string,

"envelope": string,

"status": string,

"created_at": string

}

]

}

Error codes

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

Last updated on

Was this page helpful?