Signatures
Envelope Check
Verifies whether all required actions to open an envelope have been completed.
- The envelope is identified using the transactionId (tid) query parameter, typically obtained from the GET /signatures/envelope/list endpoint.
- The endpoint checks for completion of required actions, such as legal terms acceptance.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
Query Parameters
tid?string
Transaction token identifying a specific recipient+envelope pair. Required for anonymous/recipient access (no Authorization header, or the header doesn't resolve to the envelope owner).
Format
uuidResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/signatures/envelope/check"{ "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "string", "uploadDate": "string", "status": "string", "subject": "string", "createdBy": { "id": "string", "name": "string", "email": "string" } }, "recipient": { "id": "string", "role": "signer", "name": "string", "email": "string", "status": "string", "isTokenExpired": true, "legalAccepted": true, "isMfaEnabled": true, "isMfaValid": true, "hostEmail": "string", "hasUser": true }, "settings": [ {} ] } }, "origin": "string", "dateTime": "string"}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create", "dateTime": "2026-07-20T12:00:00.0000000+00:00"}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create", "dateTime": "2026-07-20T12:00:00.0000000+00:00"}