Skip to content

DocuSign: Returns a URL to the shared recipient view UI for an envelope

DocuSign esignature.esignatureViewsPostEnvelopeRecipientSharedView: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_views_postenveloperecipientsharedview

Provider route: POST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureViewsPostEnvelopeRecipientSharedView"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureViewsPostEnvelopeRecipientSharedView(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_views_post_envelope_recipient_shared_view(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.envelopeIdstringRequired within parent
bodyModelOptionalExpand Returns a URL to the shared recipient view UI for an envelope — request body — body

Referenced models: Returns a URL to the shared recipient view UI for an envelope — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Creates a template recipient preview — response body

Referenced models: Creates a template recipient preview — response body

Creates a template recipient preview — response body
FieldTypePresenceDescription and constraints
$objectRoot
urlstringOptionalURL for the template edit view.
Returns a URL to the shared recipient view UI for an envelope — request body — body
FieldTypePresenceDescription and constraints
$objectRootThe request body for the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/)
and
[EnvelopeViews: createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/) methods.
assertionIdstringOptionalA unique identifier of the authentication event executed by the client application.
authenticationInstantstringOptionalA sender-generated value that indicates the date and time that the signer was authenticated.
authenticationMethodstringOptionalRequired. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer.

Choose a value from this list:
* Biometric
* Email
* HTTPBasicAuth
* Kerberos
* KnowledgeBasedAuth
* None
* PaperDocuments
* Password
* RSASecureID
* SingleSignOn_CASiteminder
* SingleSignOn_InfoCard
* SingleSignOn_MicrosoftActiveDirectory
* SingleSignOn_Other
* SingleSignOn_Passport
* SingleSignOn_SAML
* Smartcard
* SSLMutualAuth
* X509Certificate

This information is included in the Certificate of Completion.
clientURLsModelOptionalExpand Creates a template recipient preview — request body — body client UR Ls
clientUserIdstringOptionalA sender-created value. If provided, the recipient is treated as an embedded (captive) recipient or signer.

Use your application's client ID (user ID) for the recipient. Doing so enables the details of your application's authentication of the recipient to be connected to the recipient's signature if the signature is disputed or repudiated.

Maximum length: 100 characters.
displayFormatstringOptional
emailstringOptional(Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.
frameAncestorsarrayOptionalAn array of ancestors that can embed the frame. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/).

In the demo environment, include your site URL and `https://apps-d.docusign.com`. You can use `http://localhost` for local development and testing. Example: `["https://my.site.com", "https://apps-d.docusign.com"]`

In the production environment, include your site URL and `https://apps.docusign.com`. HTTPS must be enabled on your site. Example: `["https://my.site.com", "https://apps.docusign.com"]`
frameAncestors[]stringEach item
messageOriginsarrayOptionalThe originating domain for the signature request message. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/).

In the demo environment, the value must be `https://apps-d.docusign.com`. In production, the value must be `https://apps.docusign.com`.
messageOrigins[]stringEach item
pingFrequencystringOptionalOnly used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds.
pingUrlstringOptionalThe client URL that the Docusign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received.
recipientIdstringOptionalUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
returnUrlstringOptional(Required) The URL to which the user should be redirected
after the signing session has ended.

Maximum Length: 470 characters. If the `returnUrl` exceeds this
limit, the user is redirected to a truncated URL
Be sure to include `https://` in the URL
or redirecting might fail on some browsers.


When Docusign redirects to
this URL, it will include an `event` query parameter that your app can use:

* `access_code_failed`: Recipient used incorrect access code.
* `cancel`: Recipient canceled the signing operation,
possibly by using the **Finish Later** option.
* `decline`: Recipient declined to sign.
* `exception`: A system error occurred during the signing process.
* `fax_pending`: Recipient has a fax pending.
* `id_check_failed`: Recipient failed an ID check.
* `session_timeout`: The session timed out. An account can control this timeout by using the **Signer Session Timeout** option.
* `signing_complete`: The recipient completed the signing ceremony.
* `ttl_expired`: The Time To Live token for the envelope has expired.
After being successfully invoked, these tokens expire
after five minutes.
* `viewing_complete`: The recipient completed viewing an envelope
that is in a read-only/terminal state,
such as completed, declined, or voided.

securityDomainstringOptionalThe domain in which the user authenticated.
userIdstringOptionalThe user ID of the recipient. You can use either the user ID or email and user name to identify the recipient.

If `userId` is used and a `clientUserId` is provided, the value in the `userId` property must match a `recipientId` (which you can retrieve with a GET recipients call) for the envelope.

If a `userId` is used and a `clientUserId` is not provided, the `userId` must match the user ID of the authenticating user.
userNamestringOptionalThe username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.
xFrameOptionsstringOptionalSpecifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames.

Valid values are:

- `deny`: The page cannot be displayed in a frame.
- `same_origin`: The page can only be displayed in a frame on the same origin as the page itself.
- `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property.
xFrameOptionsAllowFromUrlstringOptionalWhen the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property.

Referenced models: Creates a template recipient preview — request body — body client UR Ls

Creates a template recipient preview — request body — body client UR Ls
FieldTypePresenceDescription and constraints
$objectRoot
onAccessCodeFailedstringOptional
onCancelstringOptional
onDeclinestringOptional
onExceptionstringOptional
onFaxPendingstringOptional
onIdCheckFailedstringOptional
onSessionTimeoutstringOptional
onSigningCompletestringOptional
onTTLExpiredstringOptional
onViewingCompletestringOptional

SDK function policy ID: docusign.esignature_views_postenveloperecipientsharedview. Catalog operation: esignature:Views_PostEnvelopeRecipientSharedView. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.