Actions18
- Document Actions
- Envelope Actions
- Evidence Actions
- Signing Session Actions
- Trust Session Actions
- Webhook Actions
Envelope → Add Session
AI-generatedSummary
Adds a signing session for a signer at a zero-based position in an existing SignDocs Brasil envelope. Posts the signer details and selected policy profile to the envelope’s sessions endpoint, then includes a signing URL built from the returned URL and client secret.
Inputs
- Envelope ID (required) — ID of the envelope to add the signer session to.
- Signer Index (required) — Zero-based position of this signer in the envelope.
- Signer Name (required) — Name of the signer.
- Signer External ID (required) — External identifier for the signer.
- Policy Profile — Signing policy: Biometric, Biometric + OTP, Click + OTP, Click Only (default), or Digital Certificate.
- Additional Signer Fields — Optional cancel and return URLs, metadata JSON, OTP channel, signer birth date, CNPJ, CPF, email, or phone. An idempotency key can make retries return the original session; use a distinct key for each signer.
Output shape
A single JSON object containing the API response fields and a signingUrl.
The signingUrl is built by adding the returned client secret to the returned URL. The API response fields are not otherwise reshaped.