Define the envelope, recipients, and fields associated with a generated document.
Overview
Define the envelope, recipients, and fields associated with a generated document. FeraRender declares signing intent and returns manifest metadata; the signing system should resolve final coordinates after conversion to the signing PDF.
Key points
- FeraRender recognizes approved XML and JSON manifest filenames.
- The last recognized manifest candidate is normalized.
- The normalized result includes version, source path, raw content, envelope, recipients, and fields.
- Only fields with an anchor are retained.
- Keep manifest versions backward compatible.
Example
<fs:signatureTemplate
xmlns:fs="urn:feradel:signature-template:v1"
version="1">
<fs:envelope subject="Please review and sign"/>
<fs:recipients>
<fs:recipient key="client" type="signer"
namePath="/data/Client/displayName"
emailPath="/data/Client/email"/>
</fs:recipients>
<fs:fields>
<fs:field anchor="client.signature"
recipient="client"
type="signature"
required="true"/>
</fs:fields>
</fs:signatureTemplate>
Replace bracketed values with values issued for the target environment. Never place production tokens, API keys, or client data in screenshots or public examples.
Recommended procedure
- Place stable anchors in the rendered document.
- Embed and validate a versioned signature manifest.
- Resolve recipient keys from trusted application data.
- Generate the document, convert it, resolve anchors, and review the draft envelope.
Troubleshooting
A required field is not placed
Confirm the anchor survives conversion and the manifest refers to the same anchor and recipient key.
A recipient cannot be resolved
Supply trusted recipient data or valid name and email paths before creating or sending the envelope.
The field is offset incorrectly
Review anchor point, dimensions, offsets, and final PDF text extraction behavior.
Related documentation
Documentation source: feradelinc/feradel.render.api, reviewed against repository revision b2c3a710. Verify behavior against the deployed release before publishing exact routes, limits, or version requirements.