RecipientViewRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "RecipientViewRequest",
  "type": "object",
  "description": "Request body for generating an embedded recipient signing URL.",
  "properties": {
    "authenticationMethod": {
      "type": "string",
      "description": "The authentication method used to verify the recipient. Must match the authentication method used when the recipient was added."
    },
    "email": {
      "type": "string",
      "description": "The email address of the recipient."
    },
    "userName": {
      "type": "string",
      "description": "The full name of the recipient."
    },
    "clientUserId": {
      "type": "string",
      "description": "The client user ID of the embedded signer."
    },
    "recipientId": {
      "type": "string",
      "description": "The recipient ID."
    },
    "returnUrl": {
      "type": "string",
      "description": "The URL to redirect the signer to after the signing session ends. DocuSign appends event query parameters."
    },
    "pingUrl": {
      "type": "string",
      "description": "A URL that DocuSign pings during the signing session to confirm the parent frame is active."
    },
    "pingFrequency": {
      "type": "string",
      "description": "Frequency in seconds for ping requests."
    },
    "frameAncestors": {
      "type": "array",
      "description": "URLs allowed to iframe the signing session (CSP frame-ancestors)."
    },
    "messageOrigins": {
      "type": "array",
      "description": "Origins allowed to receive postMessage events."
    },
    "securityDomain": {
      "type": "string",
      "description": "The security domain for the signing session."
    }
  }
}