SIsignnow

Create document embedded view link

This endpoint allows API users to create an embedded view link for the specified document. The link opens the document in embedded view mode, where users can review and download it without logging in to SignNow.

You can customize the view mode experience in the editor and on the You’ve viewed a document page:

  • Set a custom logo in the editor and on the You’ve viewed a document page using logo.url.
  • Customize the Download Document button style on the You’ve viewed a document page using general.buttons.secondary.
  • Show or hide the More Actions menu in the editor using settings.visibility.
  • Show or hide the Close button in the editor using close-button.visibility.
  • Show or hide the Download Document button in the editor using download-button.visibility.
  • Show or hide the sidebar navigation buttons in the editor using icons.
  • Show or hide the Download Document button on the You’ve viewed a document page using complete-page.button-download.visibility.

Learn more about branding.

Notes

  • Embedded view links can be created for documents and document groups.
  • The link opens without authentication and can be used multiple times until it expires.
  • The link can be created for a document in any status, for example waiting for others or signed.
post/v2/documents/{document_id}/embedded-view

Request

Path parameters

Document ID.

Request body

redirect_uristring

The link that opens after a user clicks the Close button. If not set, the default page You’ve viewed a document page will be used.

link_expirationinteger

Link expiration time in minutes.

redirect_targetstring

Specifies where to open the redirect link. Can only be used if redirect_url is set. Possible values: blank - opens the link in the new tab, self - opens the link in the same tab.

Example request

{
  "redirect_uri": "https://www.signnow.com/"
}

Response

The link has been created.

Changes

No recorded changes to this operation across all 1 revision of this API.