Delete Envelope
The Yoti sign API has the functionality to delete envelopes on demand.
Sandbox: DELETE https://demo.api.yotisign.com/v2/envelopes/{envelope_id}Production: DELETE https://api.yotisign.com/v2/envelopes/{envelope_id}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
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();Error codes
If the request is unsuccessful a response code and a message will be sent
Was this page helpful?