Skip to content

Automatic Recipient Workflow

An automatic recipient allows NSE to apply a signature or seal to a document without any human interaction. Instead of sending a signing link to a person, the signature step is executed automatically on the server side using a pre-configured sealing certificate.


Prerequisites

  • A sealing certificate is configured in Organization Settings → Sealing Certificates
  • The signatureProfile value must match the friendly name of the configured eSealing certificate exactly
  • The feature flag "AutomaticRemoteSignature" is enabled on the organization
  • A valid JWT Bearer token or Personal Access Token
  • Your organization ID (organizationId)
  • A document ready to upload

API walkthrough

Step 1 — Create the envelope

POST /api/v1/organizations/{organizationId}/envelopes
Content-Type: application/json
{
  "name": "Automatic Signing Envelope",
  "expiration": {
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "mode": "absolute"
  }
}

Save the id from the response as envelopeId.

Step 2 — Upload the document

POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files
Content-Type: multipart/form-data
file=@document.pdf

Save the id from the response as fileId.

Step 3 — Create the stage

POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages
Content-Type: application/json
{
  "name": "Automatic Seal",
  "requiredRecipientCompletions": 1,
  "type": "automatic"
}

Save the id from the response as stageId.

Step 4 — Add the automatic recipient

POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients
Content-Type: application/json
{
    "languageCode": "en",
    "signatureProfile": "<profile-name>",
    "type": "Automatic"
}

Save the id from the response as recipientId.

Step 5 — Add the signature task

POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}/tasks
Content-Type: application/json
{
  "tasks": [
    {
      "field": {
        "fieldType": "AutomaticSignature",
        "id": "1234",
        "page": 1,
        "positionX": 50,
        "positionY": 200,
        "width": 200,
        "height": 60
      },
      "recipientId":"7117de33-1234-1234-1234-51809e7a3e20",
      "sortOrder":1
    }
  ]  
}

Step 6 — Send the envelope

POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/send

The stage executes immediately after sending. The seal is applied automatically and the envelope completes without any human interaction.


Downloading the signed documents

Once the envelope is completed, retrieve the artifacts via:

GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts

Then download a specific artifact (signed document or audit trail) using its artifactId:

GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts/{artifactId}