\n\n" operationId: Views_PostEnvelopeSenderView parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/returnUrlRequest' application/xml: schema: $ref: '#/components/schemas/returnUrlRequest' required: false responses: '201': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/EnvelopeViews' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: createSenderView x-ds-method: createSender x-ds-service: Envelopes x-ds-in-sdk: true x-codegen-request-body-name: returnUrlRequest /v2/accounts/{accountId}/envelopes/{envelopeId}/views/shared: post: tags: - EnvelopeViews operationId: Views_PostEnvelopeRecipientSharedView parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/recipientViewRequest' application/xml: schema: $ref: '#/components/schemas/recipientViewRequest' required: false responses: '201': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/viewUrl' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: createEnvelopeRecipientSharedView x-ds-method: createSharedRecipient x-ds-service: Uncategorized x-ds-in-sdk: true x-codegen-request-body-name: recipientViewRequest /v2/accounts/{accountId}/views/console: post: tags: - EnvelopeViews summary: Docusign Returns a URL to the authentication view UI. description: Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications. operationId: Views_PostAccountConsoleView parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/consoleViewRequest' application/xml: schema: $ref: '#/components/schemas/consoleViewRequest' required: false responses: '201': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/EnvelopeViews' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: createConsoleView x-ds-method: createConsole x-ds-service: Envelopes x-ds-in-sdk: true x-ds-examples: - description: 'The response contains the URL of the the account''s cosole. The request body contains a `returnUrl`. This is the URL that the DocuSign platform will redirect the user to when the view is closed. ' direction: both format: json response: url: https://demo.docusign.net/Member/StartInSession.aspx?StartConsole=1&t=644ea697-2541-46ea-a8a5-d95a5c23340b&accountid=624e3e00-36cb-4bcf-a4af-43918c520dab request: returnUrl: https://dsapp.example.com/return/from/console/view style: custom title: Getting a Console View URL and Setting a Return URL x-codegen-request-body-name: consoleViewRequest components: schemas: ViewUrl: type: object description: Contains a URL for an embedded view. properties: url: type: string description: The URL for the embedded view. This URL is time-limited and should be used immediately. example: https://www.example.com EnvelopeViews: type: object properties: url: type: string description: The view URL to be navigated to. description: Embedding Envelope views x-ds-definition-name: viewUrl x-ds-category: Envelopes x-ds-order: '1' x-ms-summary: Embedding Envelope views ErrorDetails: type: object description: Contains error information returned by the API. properties: errorCode: type: string description: The error code. example: example_value message: type: string description: A human-readable error message. example: example_value recipientViewRequest: type: object properties: assertionId: type: string description: A unique identifier of the authentication event executed by the client application. authenticationInstant: type: string description: A sender generated value that indicates the date/time that the signer was authenticated. authenticationMethod: type: string description: "Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. \n\nChoose a value from this list: \n* Biometric \n* Email\n* HTTPBasicAuth\n* Kerberos\n* KnowledgeBasedAuth\n* None\n* PaperDocuments\n* Password\n* RSASecureID\n* SingleSignOn_CASiteminder\n* SingleSignOn_InfoCard\n* SingleSignOn_MicrosoftActiveDirectory\n* SingleSignOn_Other\n* SingleSignOn_Passport\n* SingleSignOn_SAML\n* Smartcard\n* SSLMutualAuth\n* X509Certificate\n\nThis information is included in the Certificate of Completion." clientUserId: type: string description: 'A sender created value. If provided, the recipient is treated as an embedded (captive) recipient or signer. Use your application''s client ID (user ID) for the recipient. Doing so enables the details of your application''s authentication of the recipient to be connected to the recipient''s signature if the signature is disputed or repudiated. Maximum length: 100 characters.' email: type: string description: Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient. frameAncestors: type: array description: '' items: type: string messageOrigins: type: array description: '' items: type: string pingFrequency: type: string description: 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. pingUrl: type: string description: 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. recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. returnUrl: type: string description: "The URL that the recipient is redirected to\nafter the signing session has ended.\nDocuSign redirects to the URL\nand includes an `event` query parameter\nthat can be used by your application.\n\nPossible `event` parameter values include: \n\n* `access_code_failed`Information Security notice: This method provides full access to the sender's user account.\nWhen you use this view, the sender has full access to the user account. If the sender user account has administrative privileges, then this method also provides administrator access.
\n\nIf your use case needs to enable a sender to update a draft envelope before it is sent, then either:
\n\n\n
\n- Configure each sender to have their own individual user account to use this API method.
\n- Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients and other envelope settings as needed.
\n