Recipient

A recipient is a person who receives an envelope. A signer is a type of recipient.

A recipient belongs to an envelope.

string

The unique identifier of the recipient.

envelope_id

uuid

The unique identifier of the envelope.

type

enum

The type of the recipient.

Available options: signer

key

string

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.

name

string

The name of the recipient.

string

The email address of the recipient.

status

enum

The current status of a recipient.

Available options are pending, sent, completed, rejected, soft_bounced, hard_bounced, failed, and replaced.

ceremony_creation

enum

How the ceremony is created for the recipient.

Available options are automatic and manual. The default is automatic.

completed_at

timestamp

Time at which the envelope was completed by the recipient, in ISO 8601 format.

status_updated_at

timestamp

Time at which the status was last updated, in ISO 8601 format.