Signatures
Envelope Decline
Declines a sent envelope.
- The envelope is identified using the transactionId (tid) query parameter, typically obtained from the GET /signatures/envelope/list endpoint.
- This endpoint is for recipients only to refuse signing or completing the envelope, for example, due to disagreements with the document content.
- Senders cannot decline an envelope.
- Declining an envelope updates its status to "Declined". declineReason is required when the envelope's own decline-reason setting requires it.
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
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/signatures/envelope/decline" \ -H "Content-Type: application/json" \ -d '{ "envelope": { "declineReason": "test" } }'{ "result": { "statusCode": 200, "message": "OK", "data": { "recipient": { "id": "871767a0-e044-4999-a16f-6b9b0ff79115", "message": "Please review and sign at your earliest convenience." } } }, "origin": "POST https://api.doctavian.com/v1/signatures/envelope/decline", "dateTime": "2026-07-20T12:00:00.000Z", "externalContext": {}, "userId": "34550f61-9411-4c6d-86ed-41b40b5fabd2"}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://api.doctavian.com/v1/signatures/envelope/decline", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "8e8dacb7-3977-42f3-8014-91971dfac2ab", "operationId": "0b8258f530a7927856dcb83637551cfb"}{ "error": { "message": "Envelope not found.", "statusCode": 500, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://api.doctavian.com/v1/signatures/envelope/decline", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "008c5605-0c48-422f-8684-ac1889564826", "operationId": "0f917c20e335db8efad220bb1dc5e23c"}