Sender

When SignatureAPI sends an email requesting a recipient to sign a document, it does so on behalf of a sender. A sender is identified by an email address, which can be personal (e.g., john@example.com) or non-personal (e.g., support@example.com). The sender’s email address appears in the body of the email (see below) and is used as the Reply-To address of the message.

​

Creating Senders

Before SignatureAPI can send requests on behalf of an email address, the address must be verified. You can add and verify senders manually via the Dashboard or programmatically using the API.

​

Creating Senders in the Dashboard

Senders are managed in the Settings → Senders section of the Dashboard.

When you created your SignatureAPI account, we automatically added a sender using your account’s email address. This sender is already verified. To add a new sender, click the New Sender button and enter the email address you’d like to verify.

After you add a sender, SignatureAPI sends a verification email to the specified address. The recipient must click the verification link to complete the process.

Initially, the sender’s status is set to pending_verification. Once the email owner clicks the link and verifies the address, the status updates to verified. If there’s an issue (e.g., the email bounces), the status changes to failed.

​

Creating Senders via API

If you need to handle verification programmatically—for example, when using SignatureAPI on a platform where your customers send documents to their clients—you can use the sender object and related endpoints to verify email addresses via the API.

Adding and verifying a sender via the API is similar to the Dashboard workflow.

First, create a sender via the API. SignatureAPI sends a verification email to the provided address, asking the recipient to click a link to confirm the email.

Once the email owner verifies the address, the status updates to verified, and the sender.verified event is triggered. If there’s an issue (e.g., the email bounces), the status updates to failed, and the sender.failed event is triggered.

​

Default Sender

When creating an envelope, you can either specify a sender explicitly or use your account’s default sender.

To specify the sender explicitly, include the sender property when creating the envelope:

// POST /v1/envelopes
{
  "title": "Dummy Agreement",
  //...
  "sender": {
    "name": "John Doe",
    "email": "john@example.com"
  },
  "documents": [
    //...
  ],
  "recipients": [
    //...
  ]
}

If you don’t specify a sender, the default sender email and name associated with your account will be used.

To change your account’s default sender, click the Set default button next to the desired sender in the Dashboard.

​

Attributes