Versioning Policy
Veriproof enterprise releases follow Semantic Versioning (semver): MAJOR.MINOR.PATCH.
Change Types
| Version component | When it changes |
|---|---|
| MAJOR | Breaking API changes, schema changes requiring manual migration, removed features |
| MINOR | New features, new API endpoints, additive schema changes |
| PATCH | Bug fixes, security patches, performance improvements, no API changes |
Support Windows
| Release type | Security patches | Feature updates | End of support |
|---|---|---|---|
| Current major | ✅ Yes | ✅ Yes | Ongoing |
| Previous major | ✅ Yes | ❌ No | 12 months after next major release |
| Older major versions | ❌ No | ❌ No | No longer supported |
Enterprise customers on an active support contract receive security patches for the previous major version for 24 months.
API Stability
The Customer Portal API and Ingest API are versioned via the /v1/ path prefix. Within v1:
- Endpoints are never removed without a deprecation notice of at least 6 months
- New optional request fields are additive and non-breaking
- Response bodies may gain new optional fields; your clients should ignore unknown fields
- Status codes and error formats are stable
v2 endpoints may be introduced alongside v1 for any breaking changes. v1 will remain supported for 12 months after v2 becomes generally available.
SDK Versioning
The .NET, Python, and TypeScript SDKs version independently of the server releases. SDK minor versions are backward compatible with the current and previous major API versions. Check the SDK changelog for the minimum supported API version.
Last updated on