Envelope status

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.

Response

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

{

  "status": <COMPLETED/ARCHIVED/ACTIVE/ERRORED>

}

Error response

The same error codes will be provided as the endpoint above. An example of an error response:

{

  "message" : "envelope not found"

}