---
title: "Generate embedded invite link"
url: "https://docs.signnow.com/docs/document-embedded-signing/operations/generate-link-for-embedded-invite"
type: "endpoint"
section: "document-embedded-signing"
slug: "document-embedded-signing/operations/generate-link-for-embedded-invite"
method: "POST"
path: "/v2/documents/{document_id}/embedded-invites/{embedded_invite_id}/link"
operation_id: "generate-link-for-embedded-invite"
authorization: "bearer"
---

# Generate embedded invite link

`POST /v2/documents/{document_id}/embedded-invites/{embedded_invite_id}/link`

This endpoint allows users to generate a link for the document embedded invite.

Retrieve the field invite `id` from the response [`POST /v2/documents/{{document_id}}/embedded-invites`](/docs/document-embedded-signing/operations/create-embedded-signing-invite).

In your request specify: 

`auth_method`: Pre-defined in [`POST /v2/documents/{{document_id}}/embedded-invites`](/docs/document-embedded-signing/operations/create-embedded-signing-invite) request method used to authenticate a recipient within the integrated application.

## Authorization

bearer

## Path Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `document_id` | string | Yes | Document ID. |
| `embedded_invite_id` | string | Yes | ID of the embedded invite. |

## Request Body

**Schema**

```json
{
  "type": "object",
  "required": [
    "auth_method"
  ],
  "properties": {
    "auth_method": {
      "type": "string",
      "example": "none",
      "description": "Defines the method used to authenticate the recipient within the integrated application. Allowed values: `password`, `email`, `mfa`, `social`, `biometric`, `other`, `none`. Must match the value specified when creating the embedded invite."
    },
    "link_expiration": {
      "type": "integer",
      "maximum": 45,
      "minimum": 15,
      "description": "Specifies how many minutes the link will remain active. The allowed range is 15 to 45 minutes."
    },
    "session_expiration": {
      "type": "integer",
      "maximum": 1440,
      "minimum": 15,
      "description": "Specifies how many minutes the signing session will remain active.",
      "x-stoplight": {
        "id": "xrygn5ah56dle"
      }
    }
  }
}
```

**Example** (`Example 1`)

```json
{
  "auth_method": "none",
  "link_expiration": 15,
  "session_expiration": 15
}
```

## Responses

### 200

Success. Returns the generated embedded invite link for the document.

**Example** (`application/json`)

```json
{
  "data": {
    "link": "https://example.com/document/01XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  }
}
```

### 400

* `session_expiration` is not an integer.
* `session_expiration` is out of range.


**Example** (`session_expiration not integer`)

```json
{
  "errors": [
    {
      "code": 19016006,
      "message": "The `session_expiration` field must be an integer."
    }
  ]
}
```

**Example** (`session_expiration out of range`)

```json
{
  "errors": [
    {
      "code": 19016007,
      "message": "The `session_expiration` field must be between 15 and 1440 minutes."
    }
  ]
}
```

## Code Examples

> Replace `$SIGNNOW_ACCESS_TOKEN` and any `{placeholder}` values before running.

### cURL

```bash
curl -X POST \
  "https://api.signnow.com/v2/documents/{document_id}/embedded-invites/{embedded_invite_id}/link" \
  -H "Authorization: Bearer $SIGNNOW_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"auth_method": "none", "link_expiration": 15, "session_expiration": 15}'
```

---
*Full reference: https://docs.signnow.com/docs/document-embedded-signing/operations/generate-link-for-embedded-invite*