Docusign · Schema

RecipientViewRequest

Request body for generating an embedded recipient signing URL.

AgreementsContractsDigital Transaction ManagementDocumentsElectronic SignatureseSignature

Properties

Name Type Description
authenticationMethod string The authentication method used to verify the recipient. Must match the authentication method used when the recipient was added.
email string The email address of the recipient.
userName string The full name of the recipient.
clientUserId string The client user ID of the embedded signer.
recipientId string The recipient ID.
returnUrl string The URL to redirect the signer to after the signing session ends. DocuSign appends event query parameters.
pingUrl string A URL that DocuSign pings during the signing session to confirm the parent frame is active.
pingFrequency string Frequency in seconds for ping requests.
frameAncestors array URLs allowed to iframe the signing session (CSP frame-ancestors).
messageOrigins array Origins allowed to receive postMessage events.
securityDomain string The security domain for the signing session.
View JSON Schema on GitHub