Skip to main content

​
Overview

Welcome to the Syngrafii iinked Sign API Quickstart guide! This guide will help you get started with sending a package for signing using the iinked Sign API in just a few simple steps.

​
Prerequisites

  • Sandbox account with an active subscription

​
Steps

1

Create API Key

  • Log in to your account.
  • Navigate to Settings > Integration > API Keys.
  • Provide a name, click Add, and save your API key securely.
You require an active subscription to create API keys.
2

Create Add Package Request

  • Open Postman and create a new request.
  • Set the request type to POST.
  • Enter the request URL: https://sandbox.syngrafii.com/api/v1/packages/add.
  • In the Authorization tab, select API Key:
    • Key: api_key
    • Value: {{api_key}}
    • Add to: Header
  • In the Body tab, select raw and choose JSON from the dropdown.
    Request
    POST /packages/add
{
  "name": "My First Package",
  "signers": [
    {
      "firstName": "{{first_name}}",
      "lastName": "{{last_name}}",
      "email": "{{email}}"
    }
  ],
  "documents": [
    {
      "fileName": "agreement.pdf",
      "fileUrl": "{{file_url}}"
    }
  ]
}
    In production it is recommended to upload files using the Files upload API and reference them by fileId instead of fileUrl.
3

Sign Package

  • Open email and click on the Sign link.

​
Postman collection

Explore our Postman collection for additional examples to help you get started. Run In Postman