Recipients
The recipient
A recipient is a person who receives an envelope. A signer is a type of recipient.
Recipients interact with the documents in an envelope during a Ceremony. These interactions may include signing, initialing, or filling in information. Once recipients successfully complete all required actions within the envelope, their status is marked as complete.
Relationships
A recipient belongs to an envelope
Lifecycle
The recipient’s status
field indicates its current stage, tracking interaction and progress. Possible recipient status are:
awaiting | The recipient is waiting for previous recipients to complete the envelope. |
pending | The envelope has not been sent yet to the recipient. |
sent | The envelope has been sent to the recipient. |
completed | The recipient has completed the envelope. |
rejected | The recipient has declined to complete the envelope. |
soft_bounced | The email to the recipient was temporarily undeliverable. |
hard_bounced | The email to the recipient was permanently undeliverable, maybe because the email address doesn’t exist anymore. |
failed | An error ocurred and the email could not be sent to the recipient. |
replaced | The recipient was replaced with another one. |