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": "{{fieldId}}", "value": "{{fieldValue}}" } ] }'{ "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "string", "message": "string" } } }, "origin": "string", "dateTime": "string"}{ "result": { "statusCode": 202, "message": "Accepted", "data": { "fields": [ {} ] } }, "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"}