A recipient represents a person involved in an envelope — someone who signs, approves, or just receives a copy. The Integration Guide shows how to create recipients when creating the envelope; this resource goes deeper into the object and the operations on existing recipients.
| Role | Behavior |
|---|---|
SIGNER |
Must sign. Their required fields must be completed. |
APPROVER |
Must approve before SIGNERs with a higher signingOrder can sign. |
VIEWER |
Can view the document, takes no action. |
CC |
Receives a copy of the completed document, doesn’t participate in the process. |
ASSISTANT |
Can fill in fields on behalf of another recipient. |
Create recipients
Section titled “Create recipients”POST /envelope/recipient/create-manyEach recipient accepts email, name, role, and optionally signingOrder, accessAuth, and actionAuth.
See the full spec in the API Reference.
Signing order
Section titled “Signing order”With sequential signing, recipients with a lower signingOrder sign first; those sharing the same value can sign simultaneously. To enable sequential signing, set signingOrder: "SEQUENTIAL" in the envelope’s meta — see Create the envelope.
Recipient authentication
Section titled “Recipient authentication”To reinforce security for a specific recipient, beyond the API’s general authentication:
accessAuth (to view the document) |
Description |
|---|---|
ACCOUNT |
The recipient must be signed in. |
TWO_FACTOR_AUTH |
The recipient must verify with 2FA. |
actionAuth (to sign) |
Description |
|---|---|
ACCOUNT |
The recipient must be signed in. |
PASSKEY |
Requires passkey authentication. |
TWO_FACTOR_AUTH |
Requires a 2FA code. |
PASSWORD |
Requires password verification. |
EXPLICIT_NONE |
Explicitly disables action authentication. |
Update recipients
Section titled “Update recipients”POST /envelope/recipient/update-manyOnly available while the envelope isn’t COMPLETED. Accepts the same fields as creation, all optional except the id of the recipient to modify.
See the full spec in the API Reference.
Delete a recipient
Section titled “Delete a recipient”POST /envelope/recipient/deleteSee the full spec in the API Reference.
Reject on a recipient’s behalf
Section titled “Reject on a recipient’s behalf”POST /envelope/recipient/{recipientId}/rejectMarks a recipient as REJECTED without going through the normal signing flow — for example, if you’re told about the rejection through a channel outside Legaldoc and need to reflect it on the envelope.
See the full spec in the API Reference.
Get a recipient
Section titled “Get a recipient”GET /envelope/recipient/{recipientId}Returns the full object, including signingStatus (NOT_SIGNED, SIGNED, REJECTED), readStatus (NOT_OPENED, OPENED), and sendStatus (NOT_SENT, SENT).
See the full spec in the API Reference.
See also
Section titled “See also”- Fields — assigning fields to each recipient
- Integration Guide — the full creation and signing flow
- Advanced Electronic Signature — RUT, sequential order, and identity verification