Docs
Getting started
User
OAuth2
Document
Template
Document Group
Signing Link
Webhooks 2.0
Folder
Smart Fields
Team
Embedded signing (old version)
post

/v2/documents/{document_id}/embedded-invites/{fieldInviteUniqueId}/link

Creates a link for the embedded invite.

Copy the field invite unique ID from the response to POST /v2/documents/{documentUniqueId}/embedded-invites. It’s in the id parameter of every invite object.

{
      "id": "03739a736d324f9794c2e93ec7c5bda817af3f7f",
      "email": "signer@email.com",
      "role_id": "33d7925969c53b55dfc2ea6d5d1fc8e788d33821",
      "order": 1,
      "status": "pending"
    }

In your request specify: "auth_method" - signer authentication menthod; can be “password”, “email”, “mfa”, “social”, “biometric”, “other”, “none” "link_expiration" - in how many minutes the link expires, ranges from 15 to 45 minutes or null.

Request Parameters

2 Path Parameters
1 Header

Request Body

1 Example
Schema
object
auth_method
string
link_expiration
integer

Responses

1 Example
Schema
object
data
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
2 path params not set
document_id
fieldInviteUniqueId
$$.env
No $$.env variables are being used in this request.