Signature
Sign
Sign a PDF or DOCX document with a cryptographic signature.
Send a JSON request body with:
- document (required): object containing either base64 or url
- signer (required): signer details — email and name are required; ip and userAgent are optional and, when provided, are recorded in the audit trail certificate. No other signer fields are accepted; use metadata for anything application-specific.
- auditTrail (required): array of signing events. Must include at least one submit event for e-signature compliance.
- eventId (optional): unique identifier for the signing event
- metadata (optional): free-form object for application-specific context (tenantId, contractId, etc.)
- certificate (optional): { enabled: boolean } — controls whether an audit trail certificate page is appended (default: true)
The response returns the signed PDF as base64.
post/v1/sign
Request body
Example request
{
"signer": {
"email": "jane@example.com",
"name": "Jane Smith",
"ip": "203.0.113.42",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"
}
}Response
Default Response