This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
Signer states
signers[].status on GET /v1/ecm/envelopes/{envelopeId}.States
| Status | Meaning |
|---|---|
None | The envelope has not been published yet — or it expired, which resets everyone who had not finished. |
Queued | Published, but not this signer's turn. Only occurs when signInOrder is on. |
ReadyToReview | Invited and able to act. The reminder ladder is counted from the moment this begins. |
Approved | Completed their part. |
Rejected | Declined. The envelope becomes Rejected. |
CancelledByMfaError | Failed identity validation in a way that stopped the workflow. |
signInOrder on, signers are released one at a time in the order you sent them: the first is ReadyToReview while the rest are Queued, and each approval promotes the next. With it off, everyone becomes ReadyToReview at publication.Signed only once every required signer is Approved.Companion fields
| Field | Notes |
|---|---|
index | The signer's position, assigned from the order you sent. Read-only. |
hadApproved / approvedAtUtc | Whether and when they approved. |
hadRejected / rejectedAtUtc | Whether and when they rejected. |
actions | The audit trail — see below. |
Actions
signers[].actions records what the signer did, each entry with createdAtUtc, ip, userAgent and location.| Type | Meaning |
|---|---|
View | Opened the envelope. |
Approval | Completed their part. |
Rejection | Declined. |
CancellationByMfaError | Identity validation failed. |
ConfirmSignMark | Filled or signed a mark. |
UnconfirmSignMark | Undid one. |
EmailMfaRequest | Requested a code by email. |
SmsMfaRequest | Requested a code by SMS. |
WhatsAppMfaRequest | Requested a code by WhatsApp. |
PixMfaRequest | Started Pix validation. |
Unsubscribe | Opted out of reminder emails. |
signMarkId, signMarkType and valueJson capture which mark was involved and its value at that moment. That is how you collect form field answers — including which option a dropdown landed on.Getting a signer moving
GET /v1/ecm/envelopes/{envelopeId}/signers/{signerId}/signature-link — is how you reach a signer with no email, or one you would rather contact yourself. The signer must already be ReadyToReview: you cannot generate a link before publishing, or for a signer still Queued.POST /v1/ecm/envelopes/{envelopeId}/manual-reinvite-to-review — re-sends the invitation to every signer currently ReadyToReview, on top of the automatic reminders. It ignores reminder opt-outs.429, regardless of your rate limit budget. Note that the call stops at the first signer that trips the cooldown, so on a multi-signer envelope some may already have been mailed when you get the error — treat it as partial success, not as a no-op.Modified at 2026-08-30 02:32:37