Changelog¶
All notable changes to the LexgoSign API will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[Unreleased]¶
Changed¶
- Envelope creation now returns HTTP 422 for synchronous validation failures, preserving the envelope ID and actionable
envelope.errorsfor correction. Valid creation remains HTTP 200; asynchronous sending remains HTTP 202. Integrations preparing upload-first envelopes must retain the ID from the 422 response. - Stable webhook delivery IDs across scheduled retries, all three scheduled retries now execute, and asynchronous sending no longer enqueues the same in-progress notification twice. Delivery remains best effort; see Webhook integration.
- Corrected send method/path, placement requirements, signing types versus appearance styles, and HTTP versus envelope error handling.
- Removed the canceled signing-reminder announcement and examples.
- Corrected the API reference against the implementation: void is allowed only from
IN_PROGRESS;GET /v1/envelopes/:idresponse fields; evidence422(hybrid_evidence_unavailable) and500; recipient request shape and statuses; settings and webhook response fields; upload limits (10 MB for/uploads, 50 MB for presigned uploads, 5 MB for base64); documented presigned uploads; removed unimplemented rate-limit headers and plan quotas.
Added¶
- API key usage reporting: Settings -> API keys now shows Signed documents per key and, once history is reconciled, Last used; the row menu offers Export usage report for month to date (UTC, up to the exact request instant) or a previous month, sent as the key's FES/FEA workbooks, with the Metadata column, to the requesting administrator's verified email. No change to the API.
- Docs: Usage reports
- Envelope metadata:
POST /v1/envelopesaccepts an optionalmetadataJSON object (8,192 bytes, 5 levels, 100 keys). It is returned asmetadataby authenticated envelope responses ({}for older envelopes), never in webhooks, and appears as a single Metadata column in the FES and FEA Excel usage reports' detail sheet. Invalid metadata returns HTTP 422 before any envelope is created. - Docs: Envelope metadata, Usage reports
- Signature background image (watermark) scope:
settings.signature.bg_image_scope(QUALIFIED_CHILE/INTERNATIONAL/ALL, defaultQUALIFIED_CHILE; legacyFEA/FESaliases remain accepted) controls whether thebg_imagewatermark is composited behind the signature on the FEA (QUALIFIED_CHILE) path, the FES (INTERNATIONAL) path, or both. Per-envelope override and persistent API-key default, same precedence as othersignaturesettings. No behavior change for existing integrations. - Docs: Signature Appearance Settings
- Sandbox vs Live guide: Documents sandbox as an API key stage on
api.lexgo.cl(not a separate host), team-member recipient allowlist, watermark, theQUALIFIED_CHILEprovider sandbox journey, and how to add allowed emails in Equipos - Docs: Sandbox vs Live
[1.1.1] - 2025-11-10¶
Added¶
- Email validation (2FA) API endpoints
- Comprehensive webhook event tracking for validations
- Evidence tracking for validation lifecycle
[1.1.0] - 2025-11-01¶
Added¶
- Email Validation (2FA): Two-factor authentication via email verification codes
POST /v1/envelopes/:envelope_id/recipients/:recipient_id/validations/send_code- Send verification codePOST /v1/envelopes/:envelope_id/recipients/:recipient_id/validations/verify_code- Verify code- Validation Events: Six new webhook events for email validation lifecycle
recipient.validation_code_generated- Code createdrecipient.validation_code_sent- Email deliveredrecipient.validation_code_success- Successful verificationrecipient.validation_code_failed- Failed attemptrecipient.validation_code_expired- Code expiredrecipient.validation_max_attempts- Too many attempts- Security Features:
- SHA256 code hashing (never stores plain text codes)
- Constant-time comparison (timing attack prevention)
- Rate limiting (5 codes/hour, 60-second cooldown)
- Attempt limiting (3 attempts per code)
- 30-minute code expiration
- Evidence Tracking: Complete audit trail for validation events
- Custom Email Templates: Template variables for validation emails
Changed¶
- Settings API now supports validation configuration
- Evidence sheet includes validation events
Security¶
- Implemented constant-time code comparison to prevent timing attacks
- Added cryptographic hashing for verification codes
- Enhanced rate limiting to prevent abuse
[1.0.0] - 2023-01-01¶
Added¶
- Initial API release
- Envelopes API:
POST /v1/envelopes- Create envelopeGET /v1/envelopes/:id- Get envelope detailsPUT /v1/envelopes/:id/send- Send invitationPUT /v1/envelopes/:id/void- Cancel envelopeGET /v1/envelopes/:id/evidence- Get evidence sheet- Settings API:
GET /v1/settings- Get configurationPUT /v1/settings- Update configuration- Webhooks API:
GET /v1/webhooks- List webhooksPOST /v1/webhooks- Create webhookGET /v1/webhooks/:id- Get webhookPUT /v1/webhooks/:id- Update webhookDELETE /v1/webhooks/:id- Delete webhook- Webhook Events:
- Envelope events:
envelope.in_progress,envelope.success,envelope.voided - Recipient events:
recipient.email_sent,recipient.email_received,recipient.email_opened,recipient.email_clicked,recipient.email_bounced,recipient.link_generated,recipient.in_progress,recipient.signed_all,recipient.rejected - Authentication: API key-based authentication
- Multi-tenant Support: Enterprise-level data isolation
- Evidence Sheets: Comprehensive audit trails with timestamps and IP addresses
- Custom Email Templates: Configurable email content and branding
- Multi-language Support: English and Spanish localization
Version History¶
| Version | Release Date | Status | Notes |
|---|---|---|---|
| 1.1.0 | 2025-11-01 | Current | Email validation (2FA) |
| 1.0.0 | 2023-01-01 | Stable | Initial release |
Upcoming Features¶
Planned for v1.2.0¶
- Phone number validation (SMS-based 2FA)
- ID document verification
- Biometric validation support
- Batch envelope operations
- Advanced search and filtering
Under Consideration¶
- GraphQL API
- Real-time notifications via WebSockets
- Template management API
- Bulk recipient management
- Advanced reporting endpoints
Deprecation Policy¶
When we deprecate an API feature:
- Announcement: 6 months advance notice via email and changelog
- Documentation: Clear deprecation warnings added to docs
- Parallel Support: Old and new versions supported simultaneously
- Migration Guide: Detailed upgrade instructions provided
- Sunset Date: Feature removed after deprecation period
Breaking Changes¶
v1.1.0¶
- No breaking changes: All changes are backward compatible
- Email validation is opt-in (disabled by default)
- New webhook events are additive
v1.0.0¶
- Initial release (no breaking changes)
Security Updates¶
We take security seriously. Security updates are released as soon as fixes are available.
Reporting Security Issues¶
Do not report security vulnerabilities in public issues.
Email security issues to: seguridad@lexgo.cl
We'll respond within 48 hours and provide a timeline for fixes.
Support¶
For questions about changes: - Contact: Contact form - Documentation: docs.lexgo.cl