---
title: "Generate embedded invite link"
method: POST
path: "/v2/documents/{document_id}/embedded-invites/{embedded_invite_id}/link"
---

# Generate embedded invite link

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

## Request

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

This endpoint allows API users to generate a link for a 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.

## Request body

- object
  - `auth_method` string, required: 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` integer: Specifies how many minutes the link will remain active. The allowed range is 15 to 45 minutes.
  - `session_expiration` integer: Specifies how many minutes the signing session will remain active.

## Response `200`

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

- object
  - `data` object: Embedded signing link.
    - `link` string: Embedded signing link for the document.

## Other responses

- `400`: * `session_expiration` is not an integer. * `session_expiration` is out of range.

---

[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)