Generate embedded invite link

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.

In your request specify:

auth_method: Pre-defined in POST /v2/documents/{{document_id}}/embedded-invites request method used to authenticate a recipient within the integrated application.

post/v2/documents/{document_id}/embedded-invites/{embedded_invite_id}/link

Request

Base URL
https://api.signnow.com
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.

Path parameters

Document ID.

ID of the embedded invite.

Request body

auth_methodstring 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_expirationinteger

Specifies how many minutes the link will remain active. The allowed range is 15 to 45 minutes.

session_expirationinteger

Specifies how many minutes the signing session will remain active.

Example request

{
  "auth_method": "none"
}

Response

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

Changes

No recorded changes to this operation across all 1 revision of this API.