EnvelopeViews: createTemplateRecipientPreview

Request

HTTP request

POST /v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

templateIdstring

The ID of the template.

Responses

CodeDescriptionReference
201

Successful response.

TemplateViews
400

Error encountered.

errorDetails

SDK Method

Envelopes::createTemplateRecipientPreview

Definitions

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

recipientPreviewRequest

assertionIdstring

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

authenticationInstantstring

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

authenticationMethodstring

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.

pingFrequencystring

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.

pingUrlstring

A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received.

recipientIdstring

The recipientId used when the envelope or template was created.

returnUrlstring

securityDomainstring

The domain in which the user authenticated.

xFrameOptionsstring

xFrameOptionsAllowFromUrlstring

TemplateViews

Embedding template views

urlstring

The view URL to be navigated to.

}} />