Envelope status

AI Tools

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>/status

Production:

GET https://api.yotisign.com/v2/envelopes/<envelopeId>/status

The same headers are required as for the endpoint above.

On success, we return a 200 with a JSON body matching the following schema:

{

"status": "COMPLETED"

}

{

"status":"ARCHIVED"

}

{

"status": "ACTIVE"

}

{

"envelope_id": "<envelopeId>",

"status": "ERRORED",

"details": {

"errors": [

{

"file_name": "sample.pdf",

"code": "<ERROR MESSAGE>"

}

]

}

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

Last updated on

Was this page helpful?