---
title: "Creates an envelope recipient preview."
method: POST
path: "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview"
tags: ["EnvelopeRecipients"]
---

# Creates an envelope recipient preview.

`POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview`

## Request

- Base URL: `https://www.docusign.net/restapi`
- URL: `https://www.docusign.net/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview`
- Auth: none declared

Returns a URL to preview the recipients' view of a draft envelope or template. You can embed this view in your application to enable the sender to preview the recipients' experience.

You must specify a `returnUrl` value in the request body.

For more information, see [Preview and Send](https://support.docusign.com/s/document-item?bundleId=ulp1643236876813&topicId=oeg1578456408976.html).

## Path parameters

- `accountId` string, required
- `envelopeId` string, required

## Request body

- RecipientPreviewRequest: This request object contains the information necessary to create a recipient preview.
  - `assertionId` string: A unique identifier of the authentication event executed by the client application.
  - `authenticationInstant` string: A sender-generated value that indicates the date and time that the signer was authenticated.
  - `authenticationMethod` string: 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
    - `onAccessCodeFailed` string
    - `onCancel` string
    - `onDecline` string
    - `onException` string
    - `onFaxPending` string
    - `onIdCheckFailed` string
    - `onSessionTimeout` string
    - `onSigningComplete` string
    - `onTTLExpired` string
    - `onViewingComplete` string
  - `pingFrequency` string: 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: 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: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
  - `returnUrl` string: The URL to which the user will be redirected in an exit scenario. For example, if the link has expired, the user will be redirected to the URL provided here. This value must be an absolute URL. This property is required.
  - `securityDomain` string: The domain in which the user authenticated.
  - `xFrameOptions` string: 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: 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.

## Other responses

- `400`: Error encountered.

## Changes

- **2019-10-08** (v2) `69cda11bf08a`: 2 info
  - api tag `EnvelopeRecipients` added
  - api tag `EnvelopeViews` removed
- **2019-07-18** (v2) `8ad1b5a40f1b`: 2 info
  - api tag `EnvelopeViews` added
  - api tag `EnvelopeRecipients` removed

[Operation history](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api/changes/v2.1/accounts/:accountId/envelopes/:envelopeId/views/recipient_preview/post.md)

---

[API](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api.md) - [All operations](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api/revisions/77f1998c313d?raw)