Find envelope

AI Tools

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

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

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

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

JSON
    
 
{      "envelope_ids": [        <id>,        <id>     ]    }
Copy

Example code

Javascript
Java
PHP
C#
Go
    
​x
 
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 requestlet result = await findEnvelope();
Copy

Example Response

JSON
    
 
{  "envelopes": [    {      "envelope_id": string,      "envelope": string,      "status": string,      "created_at": string    }  ]}
Copy

Error codes

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

Last updated on

Was this page helpful?