Sender
When SignatureAPI sends a request for 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
).
Before sending requests on behalf of an email address, SignatureAPI requires the email to be verified. Typically, you can verify the sender in the Settings -> Senders section of the Dashboard.
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 the email address via the API.
After creating a sender, SignatureAPI sends an email to the specified address, asking the owner to click a link to verify the email. 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, such as the email bouncing, the status changes to failed
.
Attributes
The unique identifier of the sender.
The email address of the sender.
The current status of the sender.
Available options are pending_verification
, verified
, and failed
.
Time at which the sender was created, in format.
Was this page helpful?