Create your first template

A Template is a reusable envelope that you can use to create multiple envelopes with the same document and recipient settings. Learn more about Template.

To create a new template, see the POST /v2/template endpoint documentation.

curl --request POST \
  --url https://restapi.sign.plus/v2/template \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My wonderful template"
}'

On success, the API will return a response with the template ID in a format like 66873403520e051cdb834df. Get the template ID from the response to use in the next steps.

A Document is a file that you want to get signed by recipients. You can add one or more documents in an Template. Learn more about Documents.

To add a document to the template, see the POST /v2/template/{template_id}/document endpoint documentation.

curl --request POST \
  --url https://restapi.sign.plus/v2/template/{template_id}/document \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=<string>'

On success, the API will return a response with the document ID in a format like 66873403520e051cdb834df. Get the document ID from the response to use in the next steps.

A Recipient is a person who will sign the document in the envelope. You can add one or more recipients to an envelope in a specific order using signing steps. Learn more about Recipients and Signing Steps.

To add a recipient to the template, see the POST /v2/template/{template_id}/signing_steps endpoint documentation.

curl --request POST \
  --url https://restapi.sign.plus/v2/template/{template_id}/signing_steps \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "signing_steps": [
    {
      "recipients": [
        {
          "name": "John Doe",
          "email": "john.doe@gmail.com",
          "role": "SIGNER",
        }
      ]
    }
  ]
}'

On success, the API will return a response with the recipient ID in a format like 66873403520e051cdb834df under the signing steps. Get the recipient ID from the response to use in the next steps.

A Signature Annotation serves as a designated placeholder within a document where the recipient is required to sign. You can include one or more signature annotations in a document. These annotations can be added alongside other types of annotations, such as text fields, date fields, and checkboxes. For further details, visit Annotation.

Before adding the annotation, you need to define your signature in the Sign.Plus platform.

To learn how to add a signature annotation to a document, refer to the POST /v2/document/{template_id}/annotation endpoint documentation.

curl --request POST \
  --url https://restapi.sign.plus/v2/template/{tmeplate_id}/annotation \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "recipient_id": "<string>",
  "document_id": "<string>",
  "page": 1,
  "x": 50,
  "y": 20,
  "width": 20,
  "height": 60,
  "required": true,
  "type": "SIGNATURE",
  "signature": {
    "id": ""
  },
  "initials": null,
  "text": null,
  "datetime": null,
  "checkbox": null
}'

On success, the API will return the inserted annotation.

You successfully created a template, added a document, set a recipient, and inserted a signature annotation. Now, it’s time to create a new envelope from the template.

To create a new envelope, see the POST /v2/envelope/{template_id} endpoint documentation.

curl --request POST \
--url https://restapi.sign.plus/v2/envelope/{template_id} \
--header 'Authorization: <api-key>' \
--data '{
"name": "My wonderful envelope from template",
}'

On success, the API will give you a response with the envelope ID in a format like 66873403520e051cdb834df. Get the envelope ID from the response to set the recipients details and send the envelope for signature.