Recipient
A recipient is a person who receives an envelope. A signer is a type of recipient.
A recipient belongs to an envelope.
Attributes
The unique identifier of the recipient.
The unique identifier of the envelope.
The type of the recipient.
Available options: signer
A user-provided key that identifies a recipient within an envelope.
It must be up to 32 alphanumeric, lowercase characters and must start with a letter.
The name of the recipient.
The email address of the recipient.
The current status of a recipient.
Available options are pending, sent, completed, rejected, soft_bounced, hard_bounced, failed, and
replaced.
How the ceremony is created for the recipient.
Available options are automatic and manual. The default is automatic.
How the deliverable (signed document) is delivered to the recipient.
Available options are email and none. The default is email.
Time at which the envelope was completed by the recipient, in ISO 8601 format.
Time at which the status was last updated, in ISO 8601 format.
Was this page helpful?