Archive envelope
The Yoti Sign API has an ‘archive’ function. This allows senders to cancel an envelope that has been sent for signing, but has not yet been signed by all recipients. The envelope will then no longer be available for signing.
Sandbox:PATCH https://demo.api.yotisign.com/v2/envelopes/<envelopeId>Production:PATCH https://api.yotisign.com/v2/envelopes/<envelopeId>The Archive Envelope endpoint returns a status code of 204 if successful.
Example code
x
const rp = require("request-promise");const archiveEnvelope = () => { const request = { method: "PATCH", uri: "<BASE_URL>/v2/envelopes/<envelopeId>", headers: { authorization: "Bearer <API_KEY>", }, }; return rp(request) .then((body) => body) .catch((err) => err);};//send requestlet result = await archiveEnvelope();Error codes
If the request is unsuccessful a response code and a message will be sent
Was this page helpful?