EnvelopeAuditEvent: describe the payload actually signed, and name 'revoked'

[EgorPPS]

Follow-up to #1111, which registered docusigner's five ontologies. Descriptions only — no field, type or enum changes, and the schemaId is unchanged.

docusigner now writes signed audit events for the first time. The occasion is withdrawal: a sender stopping a document they had already sent out for signature.

1. signedPayload described a string we do not sign.

It said the composition is ${action}|${envelopeId}|${actorEName}|${occurredAt}. What the wallet actually signs is that composition with a domain tag, hashed and prefixed:

audit_<sha256("docusigner.audit.v1|<action>|<envelopeId>|<actorEName>|<occurredAt>")>

The tag is domain separation — an audit signature must not be replayable as a signature on a document. The hash keeps the signed string short and of fixed length (70 characters), which matters because it travels to the wallet inside a QR code somebody has to photograph.

This is the kind of schema error worth fixing quickly: a verifier following the old sentence recomposes a string that never existed, and concludes that a perfectly good signature is bad.

2. The class description named only declined as the action worth signing.

revoked belongs beside it — it is equally a statement its author may have to defend. The description now also states the timing, because the timing is a deliberate design choice rather than an implementation detail: the withdrawal is written unsigned the instant it takes effect, since stopping a document must not wait for somebody to find their phone, and the signature is asked for immediately afterwards. isAttested is what tells a reader which of the two they are holding, and an unsigned one must never be read as the sender's own statement.

🤖 Generated with Claude Code

[coderabbitai]

Important

• 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 8c05dd59-ddd3-4238-a1ff-d0861378e022

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}