Links

Overview

When adding or updating a package you can set generateSignerLinks to true and return signer links. Signer links are URLs that allow signers to sign packages or join VSR meetings. You can utilize these links to create custom integrations, for example, sending them via email, SMS, or embedding them in your own applications.

Request

POST /packages/add
{
  "name": "New Package with Links",
  "type": "concurrent",
  "state": "open",
  "generateSignerLinks": true,
  },
  "signers": [
    {
      "firstName": "signer",
      "lastName": "one",
      "email": "signer.one@syngrafii.com"
    }
  ],
  "documents": [
    {
      "fileName": "document.pdf",
      "fileId": "682f1158-e3f5-4329-8f88-c52cb5447d8c"
    }
  ]
}

Links can be generated when calling packages/add, packages/update , or packages/{packageId}/link API endpoints.

When you add a package with generateSignerLinks set to true, subsequent requests to update the package will also return new signer links. You can override this behavior by setting generateSignerLinks to false in the packages/update request.

Response

Signing link
Meeting link (VSR)
Edit link

A signing link will automatically take the signer to the next unsigned document or IDV if enabled.

Response

{
    "package": {
        ...
        "signers": [
            {
                ...
                "signLink": "https://sign.syngrafii.com/link/abcdef123456"
                ...
            }
        ],
        ...
    }
}

A VSR meeting link will automatically take the participant to the VSR meeting room lobby.

Response

{
    "package": {
        ...
        "signers": [
            {
                ...
                "meetingLink": "https://sign.syngrafii.com/link/abcdef123456"
                ...
            }
        ],
        ...
    }
}

An edit link allows you to embed our package editor experience within an iframe in your application.If you set embedded to true in the package options when adding or updating a package, the edit link will be included in the response.

Response

{
    "package": {
        ...
        "editLink": {
            "link": "https://sign.syngrafii.com/link/abcdef123456"
        },
        ...
    }
}

You can also generate a new edit link for an existing package by calling the Packages link API endpoint:

Request

POST /packages/{packageId}/link/edit

Linking

To link to a signing package or VSR meeting, you can use the signLink or meetingLink URL provided in the package details. This link will take the user directly to the signing experience for their documents.

Signing link redirect
Meeting link redirect

<a href="https://sign.syngrafii.com/link/abcdef123456">Sign Document</a>

<a href="https://sign.syngrafii.com/link/abcdef123456">Join Meeting</a>

Redirecting

During add package you can optionally specify a returnUrl and returnState for each signer. When a signer completes the signing process, they will be redirected back to your application using the specified returnUrl and optional returnState.

Request

POST /packages/add
{
  "name": "New Package with Return URL",
  "type": "concurrent",
  "state": "open",
  "generateSignerLinks": true,
  "signers": [
    {
      "firstName": "signer",
      "lastName": "one",
      "email": "signer.one@syngrafii.com",
      "returnUrl": "https://example.com/thank-you",
      "returnState": "some-state"
    }
  ],
  "documents": [
    {
      "fileName": "document.pdf",
      "fileId": "682f1158-e3f5-4329-8f88-c52cb5447d8c"
    }
  ]
}

Return parameters

When the signer is redirected back to your application, the following parameters will be included in the query string:

string

The package ID of the signing package.

string

The signer ID of the signer.

boolean

When true, indicates that the signing process was completed successfully.

string

The value of returnState if provided when adding the signer.

Embedding

You can also embed the signing experience directly into your application using an iframe. This allows users to sign documents without leaving your site. View the Embed signing guide for more information.

Lifetime

Signing links are valid until the signing package becomes executed, rescinded, expired, or deleted. They will expire within 24 hours of their sign by date. Meeting links will allow hosts and signers to still join the VSR lobby for up to 7 days after it is executed. They will expire 7 days after the scheduled meeting start time.

When updating a signer’s:

Email address => all existing signer links will be invalidated.
Mobile number => all existing mobile signer links will be invalidated.

It is recommended that you update any existing links you might have stored from previous requests to ensure signer links remain valid.

Getting started

Guides

API

Webhooks

Reference

Overview

Request

Response

Linking

Redirecting

Return parameters

Embedding

Lifetime

​Overview

​Request

​Response

​Linking

​Redirecting

​Return parameters

​Embedding

​Lifetime

Overview

Request

Response

Linking

Redirecting

Return parameters

Embedding

Lifetime