Skip to main content
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>'
{
  "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

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

Parameters

packageId
string
required
The unique identifier of the package you want to generate a sign link for.
signerId
string
required
The unique identifier of the signer you want to generate a sign link for.

Response

packageId
string
Unique identifier of the package the link was generated for.
name
string
Display name for of the package the link was generated for.
URL that grants access to the package.
type
string
default:"package_sign"
Type of link returned.
token
string
Token generated to provide access to the package.
timeExpires
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"
}