---
title: "Create document embedded view link"
method: POST
path: "/v2/documents/{document_id}/embedded-view"
---

# Create document embedded view link

`POST /v2/documents/{document_id}/embedded-view`

## Request

- Base URL: `https://api.signnow.com`
- URL: `https://api.signnow.com/v2/documents/{document_id}/embedded-view`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/signnow/apis/signnow-api/docs/v2/documents/:document_id/embedded-view/post.ts> (a function with typed inputs; its response is checked against the schema)

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](/docs/guides-branding#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.

## Request body

- object
  - `redirect_uri` string: 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_expiration` integer: Link expiration time in minutes.
  - `redirect_target` string: 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.

## Response `200`

The link has been created.

- object
  - `data` object: Response data.
    - `link` string: Embedded view link for the document. The link contains a temporary access token and is valid for the time set in `link_expiration`.

## Other responses

- `400`: - The bearer token is incorrect. - The payload is incorrect. - The `link_expiration` value type is incorrect. - The `link_expiration` range value is incorrect. Must be between 43200 minutes (30 days) and 518400 minutes (360 days). - The `redirect_uri` value type is incorrect. - The `redirect_uri` field is empty. - The `redirect_uri` value is too long. - The `redirect_uri` has an incorrect format. - The `redirect_target` field value is incorrect. - The `redirect_uri` field is required when `redirect_target` is added.
- `403`: - The application is not external. - The user is not a document owner.
- `404`: The document is not found.
- `422`: - The specified document is a template. - The specified document has been deleted. - The specified document has been archived.

---

[API](https://skmtc.dev/signnow/apis/signnow-api.md) - [All operations](https://skmtc.dev/signnow/apis/signnow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signnow/apis/signnow-api/revisions/1c9c30a6142b?raw)