{
  "id": "re_26w2VVV5JVm4j459TY5BNM",
  "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
  "type": "signer",
  "key": "provider",
  "name": "Emily Johnson",
  "email": "emily@example.com",
  "status": "completed",
  "ceremony_creation": "automatic",
  "delivery_type": "email",
  "completed_at": "2025-12-31T15:00:00.000Z",
  "status_updated_at": "2025-12-31T15:00:00.000Z"
}

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. Learn more about the recipient lifecycle.

A recipient belongs to an envelope.

​
Attributes

​
id
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 unique identifier you assign to each recipient in the envelope.

It’s used to match recipients with the places they should interact with (like signature fields) and to identify them in events and webhook notifications.

It must be unique within the envelope, contain up to 32 lowercase letters or numbers, and start with a letter.

​
name
string

The name of the recipient.

​
email
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.

​
delivery_type
enum

How the deliverable (signed document) is delivered to the recipient.

Available options are email and none. The default is email.

​
completed_at
timestamp

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

​
status_updated_at
timestamp

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

{
  "id": "re_26w2VVV5JVm4j459TY5BNM",
  "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
  "type": "signer",
  "key": "provider",
  "name": "Emily Johnson",
  "email": "emily@example.com",
  "status": "completed",
  "ceremony_creation": "automatic",
  "delivery_type": "email",
  "completed_at": "2025-12-31T15:00:00.000Z",
  "status_updated_at": "2025-12-31T15:00:00.000Z"
}