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

# Generate embedded invite link

`POST /v2/document-groups/{document_group_id}/embedded-invites/{embedded_invite_id}/link`

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

Copy the document group embedded invite `id` from the response [`POST /v2/document-groups/{{document_group_id}}/embedded-invites`](/docs/doc-group-embedded-signing/operations/create-embedded-invite-document-group). 

In your request specify:
* `email`: Signer's email address.

* `auth_method`: Pre-defined in [`POST /v2/document-groups/{document_group_id}/embedded-invites`](/docs/doc-group-embedded-signing/operations/create-embedded-invite-document-group) request method used to authenticate the signer within the integrated application.


## Authorization

bearer

## Path Parameters

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

## Request Body

**Schema**

```json
{
  "type": "object",
  "required": [
    "email",
    "auth_method"
  ],
  "properties": {
    "email": {
      "type": "string",
      "example": "signer1@email.com",
      "description": "Recipient's email address."
    },
    "auth_method": {
      "type": "string",
      "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": "kkrakpitk9oc3"
      }
    }
  }
}
```

**Example** (`Example 1`)

```json
{
  "email": "j.doe@mail.com",
  "auth_method": "none",
  "link_expiration": 15,
  "session_expiration": 15
}
```

## Responses

### 200

Success. Returns a link for embedded invite.

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

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

### 400

* 19020009 - `session_expiration` is not an integer.
* 19020010 - `session_expiration` is out of range.

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

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

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

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

## Code Examples

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

### cURL

```bash
curl -X POST \
  "https://api.signnow.com/v2/document-groups/{document_group_id}/embedded-invites/{embedded_invite_id}/link" \
  -H "Authorization: Bearer $SIGNNOW_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email": "j.doe@mail.com", "auth_method": "none", "link_expiration": 15, "session_expiration": 15}'
```

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