__INITIALS__
This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.
For more information, see Preview and Send.
POST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview| Parameter Name | Value | Description |
|---|---|---|
| Path Parameters | ||
| accountId | string | The external account number (int) or account ID GUID. |
| envelopeId | string | The envelope's GUID. Example: |
| Code | Description | Reference |
|---|---|---|
| 201 | Successful response. | viewUrl |
| 400 | Error encountered. | errorDetails |
This object describes errors that occur. It is only valid for responses and ignored in requests. | ||
errorCode | string | The code associated with the error condition. |
message | string | A brief message describing the error condition. |
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:
This information is included in the Certificate of Completion. |
pingFrequency | string | Only used if |
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 | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
returnUrl | string | The URL to which the sender should be redirected after viewing the preview. |
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:
|
xFrameOptionsAllowFromUrl | string | When the value of |
url | string | The endpoint to which webhook notification messages are sent via an HTTP/S POST request. For the DocuSign production platform, the url must start with https. For the demo platform, either http or https is ok. |
{
"url": "sample string 1"
}
<viewUrl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
<url>sample string 1</url>
</viewUrl>