Delete Envelope

AI Tools

The Yoti sign API has the functionality to delete envelopes on demand.

HTTP
    
 
Sandbox: DELETE https://demo.api.yotisign.com/v2/envelopes/{envelope_id}
Copy

HTTP
    
 
Production: DELETE https://api.yotisign.com/v2/envelopes/{envelope_id}
Copy

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.

Example code

Javascript
Java
PHP
    
​x
 
const rp = require("request-promise");const deleteEnvelope = () => {  const request = {    method: "DELETE",    uri: "<BASE_URL>/v2/envelopes/{envelope_id}",    headers: {      authorization: "Bearer <API_KEY>",    },  };​  return rp(request)    .then((body) => body)    .catch((err) => err);};​//send requestlet result = await deleteEnvelope();
Copy

Error codes

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

Last updated on

Was this page helpful?