create_embed_link
Create a short-lived signing URL for an embedded recipient to render in an iframe. The link expires in 10 minutes, so generate it when the signer is ready and the envelope is in progress.
Instructions
Create a short-lived signing URL for an embedded recipient, to be rendered in an iframe inside your application. The envelope must be in 'in_progress' status and the link expires after 10 minutes, so create it when the signer is ready (one link per signing session). On documents with a signingOrder the link can only be created once it is the recipient's turn; the envelope.recipient.activated webhook event signals that moment. When the session ends the iframe redirects to returnUrl with event (signing_complete, voided, expired or not_found), envelopeId, documentId and recipientId appended as query parameters; existing returnUrl query parameters are preserved.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| returnUrl | Yes | URL the signing session redirects to when it ends | |
| documentId | Yes | The envelope document ID (sourceDocumentId) | |
| envelopeId | Yes | The envelope ID | |
| recipientId | Yes | The recipient ID of the embedded recipient |