Add signer to envelope
add_session_to_envelopeAdd a signer to an existing envelope and generate a ready-to-share signing URL for identity verification.
Instructions
⚠️ This performs a consequential, possibly irreversible action (legally-binding signature request and/or quota consumption). Confirm with the human before calling. Add a signing session for one signer to an envelope. Returns IDs plus a ready-to-share signingUrl.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"envelopeId": "<envelopeId>",
"signer": "<signer>",
"policyProfile": "<policyProfile>",
"signerIndex": "<signerIndex>"
},
"name": "add_session_to_envelope"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| signer | Yes | The person who will sign / authenticate. | |
| purpose | No | DOCUMENT_SIGNATURE to sign a PDF; ACTION_AUTHENTICATION to authenticate an action with no document. | |
| metadata | No | Free-form key/value tags (keys ≤256, values ≤1024 chars). | |
| cancelUrl | No | ||
| returnUrl | No | ||
| envelopeId | Yes | The envelope to add a signer to. | |
| signerIndex | Yes | Zero-based position of this signer (0..totalSigners-1). | |
| policyProfile | Yes | Identity-assurance profile: CLICK_ONLY, CLICK_PLUS_OTP, BIOMETRIC, BIOMETRIC_PLUS_OTP, or CUSTOM. Read the signdocs://policy-profiles resource for the authoritative list — an invalid value returns 400. |