Skip to content

Recipients

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.
POST /envelope/recipient/create-many

Each recipient accepts email, name, role, and optionally signingOrder, accessAuth, and actionAuth.

See the full spec in the API Reference.

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.

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.
POST /envelope/recipient/update-many

Only 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.

POST /envelope/recipient/delete

See the full spec in the API Reference.

POST /envelope/recipient/{recipientId}/reject

Marks 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 /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.