Get envelope status
This endpoint allows you to query the Yoti Sign API for the current status of an envelope:
Sandbox:GET https://demo.api.yotisign.com/v2/envelopes/<envelopeId>/statusProduction:GET https://api.yotisign.com/v2/envelopes/<envelopeId>/statusThe same headers are required as for the endpoint above.
Response
On success, we return a 200 with a JSON body matching the following schema:
{ "status": "COMPLETED"}Error response
If the request is unsuccessful a response code and a message will be sent:
| Response | Description |
|---|---|
| 400 | Bad Request, example: id provided not a UUID |
| 401 | Unauthorised request, example: requesting the status on an envelope you are not authorized to view |
| 403 | Forbidden, requesting user did not create the envelope |
| 404 | The envelope ID couldn’t be found |
Was this page helpful?