EnvelopeRecipients: createEnvelopeRecipientPreview

This object describes errors that occur. It is only valid for responses and ignored in requests.

The code associated with the error condition.

A brief message describing the error condition.

This request object contains the information necessary to create a recipient preview.

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

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

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.

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.

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.

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

The URL to which the sender should be redirected after viewing the preview.

The domain in which the user authenticated.

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.

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.

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.