> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL.
>
> Documentation indexes by section:
> - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt
> - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt
> - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt
> - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt
>
> Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth
> Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks
>
> OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json
> MCP server: https://docusign.docs.buildwithfern.com/_mcp/server

# Get URL to shared recipient view UI for envelope

POST https://demo.docusign.net/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared
Content-Type: application/json

Returns a URL that enables you to embed the Docusign UI recipient view of a [shared envelope](https://support.docusign.com/s/document-item?bundleId=pik1583277475390\&topicId=uzg1583277438725.html) 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.

### Related topics

* [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/)
* [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/)
* [How to embed the Docusign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)

Reference: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient

## Authentication

- `Authorization` header (required) (prefixed with ` Bearer  `) — 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.

## Servers

- `https://demo.docusign.net/restapi` (Demo, default)
- `https://www.docusign.net/restapi` (Production)

## Request

### Path parameters

- `accountId` (string, required) — The external account number (int) or account ID Guid.
- `envelopeId` (string, required) — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`

### Body (application/json)

This endpoint expects a recipientViewRequest.

- `assertionId` (string, optional) — A unique identifier of the authentication event executed by the client application.
- `authenticationInstant` (string, optional) — A sender-generated value that indicates the date and time that the signer was authenticated.
- `authenticationMethod` (string, optional) — 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.
- `clientURLs` (recipientTokenClientURLs, optional)
- `clientUserId` (string, optional) — 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.
- `displayFormat` (string, optional) — 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.
- `email` (string, optional) — (Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.
- `frameAncestors` (list of string, optional) — An 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"]`
- `messageOrigins` (list of string, optional) — The 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`.
- `pingFrequency` (string, optional) — 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.
- `pingUrl` (string, optional) — 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.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `returnUrl` (string, optional) — (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.
- `securityDomain` (string, optional) — The domain in which the user authenticated.
- `userId` (string, optional) — 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.
- `userName` (string, optional) — The username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.
- `xFrameOptions` (string, optional) — 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.
- `xFrameOptionsAllowFromUrl` (string, optional) — 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

### 201

Successful response.

- `url` (string, optional) — URL for the template edit view.

## Errors

### 400 Bad Request Error

Error encountered.

- `errorCode` (string, optional) — The code associated with the error condition.
- `message` (string, optional) — A brief message describing the error condition.

## Types

### recipientTokenClientURLs

- `onAccessCodeFailed` (string, optional)
- `onCancel` (string, optional)
- `onDecline` (string, optional)
- `onException` (string, optional)
- `onFaxPending` (string, optional)
- `onIdCheckFailed` (string, optional)
- `onSessionTimeout` (string, optional)
- `onSigningComplete` (string, optional)
- `onTTLExpired` (string, optional)
- `onViewingComplete` (string, optional)

## Examples

**Request**

```json
{
  "assertionId": "sample string 1",
  "authenticationInstant": "sample string 2",
  "authenticationMethod": "sample string 3",
  "clientURLs": {
    "onAccessCodeFailed": "sample string 1",
    "onCancel": "sample string 2",
    "onDecline": "sample string 3",
    "onException": "sample string 4",
    "onFaxPending": "sample string 5",
    "onIdCheckFailed": "sample string 6",
    "onSessionTimeout": "sample string 7",
    "onSigningComplete": "sample string 8",
    "onTTLExpired": "sample string 9",
    "onViewingComplete": "sample string 10"
  },
  "clientUserId": "sample string 4",
  "displayFormat": "sample string 5",
  "email": "sample string 6",
  "frameAncestors": [
    "sample string 1"
  ],
  "messageOrigins": [
    "sample string 1"
  ],
  "pingFrequency": "sample string 7",
  "pingUrl": "sample string 8",
  "recipientId": "sample string 9",
  "returnUrl": "sample string 10",
  "securityDomain": "sample string 11",
  "userId": "sample string 12",
  "userName": "sample string 13",
  "xFrameOptions": "sample string 14",
  "xFrameOptionsAllowFromUrl": "sample string 15"
}
```

**Response**

```json
{
  "url": "sample string 1"
}
```