Signatures
Envelope Sign
Signs a sent and opened envelope.
- The envelope is identified using the transactionId (tid) query parameter, typically obtained from the email link sent to the recipient or via the GET /signatures/envelope/list endpoint.
- Field IDs required in the request body can be retrieved from the endpoint that provides details about the open envelope.
- This endpoint allows recipients to apply signatures and fill required fields (e.g., initials, text, checkboxes) to complete their signing obligations. For an in-person signer, the host must be a logged-in user matching the recipient's hostEmail (
HOST_USER_NOT_MATCHINGotherwise). Returns 202 instead of 200 when the digital-signature flow requires an additional client-side step to complete.
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
application/json
curl -X POST "https://example.com/signatures/envelope/sign" \ -H "Content-Type: application/json" \ -d '{ "externalContext": { "id": "12345" }, "fields": [ { "id": "9ebc217d-0d45-44ff-8144-cd77e8ca33b4", "value": "Jane Doe" } ] }'{ "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "9d05a264-4c4a-4621-a579-e50c53dd59e0", "message": "Please review and sign at your earliest convenience." } } }, "origin": "POST https://api.doctavian.com/v1/signatures/envelope/sign", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "ba85d156-f1d0-4b9f-9c91-785601d13eee"}{ "result": { "statusCode": 202, "message": "Accepted", "data": { "fields": [ {} ] } }, "origin": "POST https://api.doctavian.com/v1/signatures/envelope/sign", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "a8868726-d3da-45d4-8456-358c653b9455"}{ "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/sign", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "9a5abc60-68e7-4793-8a34-e6ffcf5f2a01", "operationId": "8e36ac3e096243fa8ce8be7ef543c4d9"}{ "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/sign", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "a47b96df-1acd-4315-a2f8-df80c5dac902", "operationId": "b37f4858600fe87d1e95b864f6211ca4"}