Skip to navigation
Docusign eSignature REST APIEnvelopesEnvelopeViews

Get URL to shared recipient view UI for envelope

View as Markdown

Returns a URL that enables you to embed the Docusign UI recipient view of a shared envelope in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them.

Due to screen space issues, do not use an <iframe> for embedded operations on mobile devices. For iOS devices, Docusign recommends using a WebView.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

The external account number (int) or account ID Guid.

envelopeIdstringRequired

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request

This endpoint expects an object: recipientViewRequest

assertionIdstringOptional
A unique identifier of the authentication event executed by the client application.
authenticationInstantstringOptional

A sender-generated value that indicates the date and time that the signer was authenticated.

authenticationMethodstringOptional

Required. 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.

clientURLsobjectOptional
clientUserIdstringOptional

A 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

This value determines whether the display will show an embedded or focused view experience. If set to focused, the display will use the focused view experience. If set to default, or if not set, the display will use the embedded experience.

emailstringOptional

(Required) Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.

frameAncestorslist of stringsOptional

An array of ancestors that can embed the frame. This property is required when using focus 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"]

messageOriginslist of stringsOptional

The originating domain for the signature request message. This property is required when using focus view.

In the demo environment, the value must be https://apps-d.docusign.com. In production, the value must be https://apps.docusign.com.

pingFrequencystringOptional

Only 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.

pingUrlstringOptional
The 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.
recipientIdstringOptional
Unique 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.
securityDomainstringOptional
The domain in which the user authenticated.
userIdstringOptional

The 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.

userNamestringOptional

The username of the recipient. You can use either email and userName or userId to identify the recipient.

xFrameOptionsstringOptional

Specifies 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.
xFrameOptionsAllowFromUrlstringOptional

When 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.

Response

Successful response.
urlstringOptional
URL for the template edit view.

Errors

400
Bad Request Error