---
title: "Embedded editor"
url: "https://docs.signnow.com/docs/guides-embedded-editor"
type: "page"
section: "Documentation"
slug: "guides-embedded-editor"
---

# Embedded editor

## About embedded editor

Embed the SignNow editor to allow your customers to edit documents without leaving your app — no registration or email required. The editor supports branding customization and document pre-filling, keeping your workflow running uninterrupted.

To embed the SignNow editor into your app, add a link that opens a document in a SignNow iFrame directly in the app. Complete two steps:

1. [Upload](/docs/document/operations/upload-document) a document
2. [Generate](/docs/embedded-editor/operations/post-v2-documents-documentUniqueId-embedded-editor) a link to the editor that can be built into your app.

See also: [Embedded signing](/docs/guides-embedded-signing).

### Before you begin

Before creating a link, make sure that:

- You are the owner of the document or document group.
- The document/document group has not been sent for signature or signed.
- The document/document group is not deleted or archived

## Embedded editor features

Embedded editor is available for [documents](/docs/embedded-editor/operations/post-v2-documents-documentUniqueId-embedded-editor) and [document groups](/docs/embedded-editor/operations/post-v2-document-groups-document_group_id-embedded-editor).

For the embedded editor, you can customize the following:

| Parameter | Description |
|---|---|
| `link_expiration` | Number of minutes until the link expires. From 15 minutes (by default) to 45 minutes. |
| `redirect_uri` | When the user closes the editor, they are redirected to this URI. |
| `redirect_target` | Defines whether the `redirect_uri` opens in a new tab or in the same browser tab. Use `self` for the same tab, and `blank` for a new tab. |

## Create a link to the embedded editor

Let’s create a link to the embedded editor for a document. For the document group embedded editor, see [Create embedded editor link for doc group](/docs/embedded-editor/operations/post-v2-document-groups-document_group_id-embedded-editor).


### Step 1. Upload a document

First, add the document that you’d like to open in the embedded editor. There are three ways to upload a document:

- [Upload a document from your computer](/docs/document/operations/upload-document)

```bash
curl --request POST \
--url https://api.signnow.com/document \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: multipart/form-data' \
--form file=@/path/to/your/file.pdf
```

- [Upload a document from a URL](/docs/document/operations/post-v2-documents-url)

```bash
curl --request POST \
--url https://api.signnow.com/v2/documents/url \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://file.com"
}'
```

- [Upload a document with text tags](/docs/document/operations/upload-document-with-text-tags)

```bash
curl --request POST \
--url https://api.signnow.com/document/fieldextract \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: multipart/form-data' \
--form file= \
--form Tags= \
--form 'Tags[]:tag_name='
```

### Step 2. Generate a link to the embedded editor

Now, let’s generate a link to the document editor that expires in 15 minutes. After completion, the person editing is redirected to the SignNow website in a new tab.

All the fields in the request body are optional. For more information, see [Create embedded editor link for document](/docs/embedded-editor/operations/post-v2-documents-documentUniqueId-embedded-editor).

```bash
curl --request POST \
  --url https://api.signnow.com/v2/documents/{{document_id}}/embedded-editor \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "redirect_uri": "https://signnow.com",
  "link_expiration": 15,
  "redirect_target": "blank"
}'
```

## Troubleshooting

### Link generation fails

The API returns an error and does not generate the link in the following cases:

| Condition | Details | What to do |
|---|---|---|
| Document/document group has a pending signing invite | A freeform or role-based invite has been sent for the document or document group. | Cancel the invite before generating the link. |
| Document/document group has been signed | Documents/document groups with existing signatures cannot be edited. | Use a new document/document group without existing signatures. |
| Insufficient subscription | Your plan does not include the API editor feature. | Contact your account manager or support to upgrade your subscription. |
| Document/document group is owned by another user | The access token must belong to the document/document group owner. | Use the document/document group you own. |
| Document is part of a document group | Documents that are part of a document group must be edited via the document group endpoint. | Use the [Create link for doc group](/docs/embedded-editor/operations/post-v2-document-groups-document_group_id-embedded-editor) request. |
| Document/document group is deleted or archived | Deleted or archived documents/document groups cannot be edited. | Restore the document/document group before generating the link. |

### Editor opens in View Only mode

If a signing invite is created for the document or document group after the embedded editor link is generated, or the document has been signed, the editor opens in View Only mode.

## Try out in Postman

[Access](https://www.postman.com/signnow-api/workspace/signnow-public-collection/collection/24778743-0f4ad1bc-5fb5-4c9c-a95a-3a62f3e775a4) this flow in Postman, and feel free to embed the document editor into your system.


---
*Full page: https://docs.signnow.com/docs/guides-embedded-editor*