Sign

POST

packages

{packageId}

link

sign

{signerId}

Sign

curl --request POST \
  --url https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId} \
  --header 'api_key: <api-key>'

import requests

url = "https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId}"

headers = {"api_key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {api_key: '<api-key>'}};

fetch('https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId}"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "packageId": "<string>",
  "name": "<string>",
  "link": "<string>",
  "type": "<string>",
  "token": "<string>",
  "timeExpires": "<string>"
}

Generate a secure link to allow a signer to sign a package without requiring authentication.

If multi-factor authentication is enabled for the signer, they will be prompted to complete the second factor after accessing the link.

Request

POST /packages/{packageId}/link/sign/{signerId}

Parameters

string

required

The unique identifier of the package you want to generate a sign link for.

string

required

The unique identifier of the signer you want to generate a sign link for.

Response

string

Unique identifier of the package the link was generated for.

string

Display name for of the package the link was generated for.

string

URL that grants access to the package.

string

default:"package_sign"

Type of link returned.

string

Token generated to provide access to the package.

string

Timestamp when the link expires (ISO 8601 format).

Examples

Response (200)

{
    "name": "Signing",
    "link": "https://sign.syngrafii.com/link/6iC4sCyjRaMTm2FcMjwIVA",
    "type": "package_sign",
    "token": "6iC4sCyjRaMTm2FcMjwIVA",
    "timeExpires": "2021-08-10T15:40:51.7746401Z",
    "packageId": "581aa1e0-49ea-4e49-841a-a74050e7d776"
}

⌘I

Sign

curl --request POST \
  --url https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId} \
  --header 'api_key: <api-key>'

import requests

url = "https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId}"

headers = {"api_key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {api_key: '<api-key>'}};

fetch('https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId}"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/sign/{signerId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "packageId": "<string>",
  "name": "<string>",
  "link": "<string>",
  "type": "<string>",
  "token": "<string>",
  "timeExpires": "<string>"
}

Getting started

Guides

API

Webhooks

Reference

Request

Parameters

Response

Examples

​Request

​Parameters

​Response

​Examples

Request

Parameters

Response

Examples