Quickstart

Please sign up on the Sign.Plus Platform to get started.

Please visit the Integrations page to activate your API sandbox and get your API key.

Create your first envelope

An Envelope is a container for documents to be signed by recipients. Learn more about Envelope.

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

curl --request POST \
  --url https://restapi.sign.plus/v2/envelope \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My wonderful envelope",
  "flow_type": "REQUEST_SIGNATURE",
  "legality_level": "SES",
  "expires_at": 1831280113,
  "sandbox": true
}'

On success, the API will return a response with the envelope ID in a format like 66873403520e051cdb834df. Get the envelope 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 Envelope. Learn more about Documents.

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

curl --request POST \
  --url https://restapi.sign.plus/v2/envelope/{envelope_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 envelope, see the POST /v2/envelope/{envelope_id}/signing_steps endpoint documentation.

curl --request POST \
  --url https://restapi.sign.plus/v2/envelope/{envelope_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/{envelope_id}/annotation endpoint documentation.

curl --request POST \
  --url https://restapi.sign.plus/v2/envelope/{envelope_id}/annotation \
  --header 'Authorization: Bearer <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 an envelope, added a document, set a recipient, and inserted a signature annotation. Now, it’s time to send the envelope for signature.

To send the envelope for signature, see the POST /v2/envelope/{envelope_id}/send endpoint documentation.

curl --request POST \
--url https://restapi.sign.plus/v2/envelope/{envelope_id}/send \
--header 'Authorization: Bearer <api-key>'

On success, the API will send the envelope for signature to the recipient. They will receive an email notification with a link to sign the document.